Research Methodology & Technical Writing

Chapter 12
Technical and Academic Writing

Bachelors Program in AI & ML
Research Methodology & Technical Writing   •   Bachelor

Technical and Academic Writing

Introduction and Context

Technical and academic writing is the principal means by which researchers communicate questions, evidence, methods, findings, and implications. In artificial intelligence and machine learning (AI and ML), writing is not an accessory to technical work. A well-designed model can be misunderstood if its assumptions are hidden, its evaluation is poorly reported, or its claims exceed the evidence. Conversely, precise writing allows readers to reproduce a study, assess its validity, compare it with previous work, and determine whether it is useful in practice.

Academic writing is directed primarily toward the advancement and critical examination of knowledge. Technical writing includes research papers, laboratory reports, software documentation, design specifications, model cards, executive summaries, and user manuals. These genres differ in audience and purpose, but all require accuracy, coherence, evidence, and responsibility.

A useful principle is that writing should answer five questions:

1. What problem is being addressed?

2. Why does the problem matter?

3. What was done, and why was it done that way?

4. What evidence was obtained?

5. What can and cannot be concluded?

The answers should form an argument rather than a collection of disconnected facts.

Learning Objectives

By the end of this chapter, students should be able to:

  • distinguish academic, technical, professional, and popular writing;
  • formulate a clear research narrative and thesis statement;
  • structure abstracts, introductions, related-work sections, methods, results, discussions, and conclusions;
  • select precise terminology and maintain logical coherence;
  • use tables, figures, equations, citations, and references responsibly;
  • distinguish reporting results from interpreting them;
  • prepare reports, theses, documentation, and executive summaries for different audiences;
  • recognize plagiarism, inappropriate paraphrasing, fabrication, and other forms of research misconduct;
  • use AI-assisted writing tools while preserving authorship, accuracy, confidentiality, and accountability.

1. The Nature of Effective Academic and Technical Writing

1.1 Purpose, audience, and genre

Writing begins with a communication purpose. A research article seeks to establish a defensible contribution. A technical report documents an investigation or project for decision-making. A thesis demonstrates independent scholarly competence. Documentation enables users or developers to operate, understand, or maintain a system. An executive summary presents the essential findings and recommendations to a non-specialist decision-maker.

Audience determines the amount of background, terminology, explanation, and detail required. A machine-learning researcher may understand “stratified cross-validation,” whereas an executive may need the phrase “evaluation using balanced data partitions.” Simplification does not mean loss of accuracy. It means expressing the same idea at an appropriate level.

1.2 The central qualities

Effective writing is:

  • Clear: readers can identify the meaning without guessing.
  • Concise: unnecessary words and repetition are removed.
  • Coherent: sentences and sections develop a connected argument.
  • Precise: claims, quantities, conditions, and limitations are stated accurately.
  • Consistent: terminology, notation, tense, formatting, and citation style do not change arbitrarily.
  • Evidence-based: important claims are supported by data, reasoning, or appropriate sources.
  • Responsible: uncertainty, limitations, risks, and contributions are represented honestly.

Clarity is not achieved by making every sentence short. Complex ideas sometimes require carefully structured sentences. The goal is controlled complexity.

1.3 The writing process

A reliable writing process usually includes five overlapping stages:

1. Planning: define purpose, audience, scope, contribution, and required evidence.

2. Structuring: create an outline that follows the logic of the investigation.

3. Drafting: write sections without attempting to perfect every sentence immediately.

4. Revising: examine argument, evidence, organization, and completeness.

5. Editing and proofreading: correct language, references, formatting, figures, and typographical errors.

Revision is more than correction of grammar. A paragraph may be grammatically correct but logically irrelevant. At sentence level, writers should ask whether the subject is clear, the verb is strong, and the claim is appropriately qualified.

2. Building a Coherent Research Argument

A research document is persuasive when its claims follow from its evidence. A useful argument structure is:

Claim → Evidence → Reasoning → Qualification.

For example, a claim might state that a proposed classifier improves recall. Evidence may be a table of test-set results. Reasoning explains why the comparison is meaningful and whether the improvement is practically important. Qualification identifies uncertainty, data limitations, or conditions under which the claim may not hold.

2.1 Research questions and thesis statements

A research question should be specific enough to investigate. “How can AI improve healthcare?” is too broad for a bachelor’s project. “Does a calibrated gradient-boosting model improve the identification of high-risk admissions compared with logistic regression on a specified dataset?” is more manageable.

A thesis statement is the central answer or position developed by the document. It should not merely announce a topic. “This thesis discusses image classification” announces a subject; “This thesis evaluates whether data augmentation improves minority-class recall in a convolutional neural network under a fixed evaluation protocol” presents an investigable position.

2.2 Paragraph architecture

A strong academic paragraph commonly contains:

  • a topic sentence stating its main point;
  • explanation or development;
  • evidence, example, or citation;
  • interpretation linking the material to the argument;
  • a transition to the next idea, when needed.

The topic sentence should not be so broad that the paragraph cannot support it. Each paragraph should generally perform one principal function: define a concept, compare methods, interpret a result, or establish a limitation.

2.3 Signposting and transitions

Signposting tells the reader how the argument is organized. Expressions such as “however,” “in contrast,” “therefore,” and “the following section evaluates” are useful when they express genuine logical relationships. Transitions should not be decorative. “However” signals contrast; “therefore” signals a conclusion supported by prior reasoning.

3. The Architecture of a Research Article or Thesis

The conventional structure is often described as IMRaD: Introduction, Methods, Results, and Discussion. Extended papers and theses add an abstract, related work, conclusion, references, and appendices. The structure is not a rigid formula; it is a way of helping readers locate information and follow the research logic.

3.1 Title

A title should identify the subject, approach, population or data context, and sometimes the principal outcome. “A Study of AI” is vague. “Evaluating Data Augmentation for Minority-Class Image Classification” is informative. Avoid unnecessary claims such as “A Revolutionary Solution” unless the evidence genuinely supports them.

3.2 Abstract

An abstract is a self-contained summary, usually written after the main document. It commonly includes:

  • Background or problem: what issue is addressed;
  • Objective: the research question or purpose;
  • Methods: data, approach, and evaluation design;
  • Results: the most important findings, preferably with relevant quantities;
  • Conclusion: the meaning and significance of the findings.

An abstract should not contain unexplained abbreviations, citations, extensive methodological detail, or claims absent from the main text. It should state what was actually done, not what was intended.

A useful abstract test is whether a reader can identify the problem, method, result, and implication without consulting the paper.

3.3 Introduction

The introduction establishes the research situation. A common progression is:

1. broad context;

2. specific problem;

3. limitations or gap in existing knowledge;

4. research objective or question;

5. contribution and document organization.

The “gap” should be demonstrated rather than asserted. A gap may be an unresolved comparison, insufficient evaluation, a population that has been neglected, contradictory findings, or a practical constraint not addressed by prior work. The introduction should distinguish a genuine knowledge gap from a simple lack of familiarity by the writer.

Contributions should be concrete. They may include a new method, a systematic comparison, an empirical finding, a dataset, a software artifact, or a design analysis. Claims of novelty should be cautious because proving that no similar work exists is difficult.

3.4 Related work and literature review

A related-work section is not a list of summaries. It synthesizes prior work according to concepts, methods, findings, datasets, or limitations. A useful synthesis compares studies:

| Dimension | Study A | Study B | Present study |

|---|---|---|---|

| Data context | Balanced benchmark | Imbalanced operational data | Imbalanced operational data |

| Main method | Logistic regression | Tree ensemble | Both as baselines and a neural model |

| Evaluation | Accuracy | F1 score | Recall, precision, F1, and calibration |

| Limitation | Limited realism | Limited interpretability | Explicit error and calibration analysis |

The table is illustrative; a real review must be based on verified sources. Literature should be selected for relevance and quality, not merely quantity. Primary research papers, authoritative standards, books, and official technical documentation may all be appropriate, depending on the claim.

A review should identify patterns and tensions. For example, studies may report higher accuracy with complex models but provide limited evidence about calibration or subgroup performance. The writer should explain how the present work responds to that situation.

3.5 Methods

The methods section permits evaluation and, where appropriate, replication. It should explain:

  • research design and rationale;
  • data sources, inclusion criteria, and preprocessing;
  • variables, features, labels, and measurement procedures;
  • algorithms, models, software, and important hyperparameters;
  • training, validation, and test procedures;
  • evaluation metrics and statistical analysis;
  • ethical approvals, privacy protections, and risk controls.

A method is not adequately described by naming a library or algorithm. “A neural network was trained using Python” omits architecture, data partitioning, optimization procedure, stopping rule, and evaluation design. Reproducibility does not require reporting every irrelevant implementation detail, but it does require reporting details that could affect the result.

The rationale for choices is also important. If accuracy is used for a highly imbalanced problem, the methods should justify it or report more appropriate measures. If a dataset is divided into training and test sets, the procedure must prevent information from the test set influencing model development. Preprocessing operations such as scaling or feature selection should be fitted using training data only, then applied to validation or test data.

3.6 Results

The results section reports observations without turning them into unsupported explanations. It may include descriptive statistics, model performance, inferential results, error analysis, and ablation studies. Tables and figures should be numbered, titled, referenced in the text, and interpretable without excessive searching.

Do not duplicate every table value in prose. Instead, identify the important pattern. For example: “The ensemble achieved the highest F1 score, while the neural model produced the best recall but also the largest calibration error.” This is more useful than repeating a complete table.

Results should include uncertainty where appropriate. A point estimate alone may conceal variability. Confidence intervals, standard deviations across repeated runs, or other suitable uncertainty measures should be reported according to the study design. Writers must not imply that a difference is meaningful merely because one number is larger.

3.7 Discussion

The discussion interprets results in relation to the research question and previous work. It should address:

  • whether the objective was achieved;
  • the meaning of the principal findings;
  • agreement or disagreement with prior studies;
  • plausible explanations for unexpected outcomes;
  • practical significance, not only numerical difference;
  • threats to validity and generalizability;
  • implications for future research or deployment.

Results and discussion should not be confused. “Recall increased from 0.71 to 0.78” is a result. “The increase may be useful where missed positive cases are costly, although the associated increase in false positives requires operational review” is discussion.

Avoid causal language unless the design supports causation. Observational associations should not be written as proof that one variable caused another. Similarly, performance on one benchmark should not be generalized automatically to all real-world settings.

3.8 Conclusion

A conclusion returns to the research question and states the answer supported by the study. It should synthesize rather than merely repeat the abstract. It may include the main contribution, practical implication, limitations, and a focused direction for future work. It should not introduce a new result, citation, or argument that was not developed earlier.

4. Precision, Style, and Technical Presentation

4.1 Terminology and definitions

Define specialized terms at first use, especially when readers may interpret them differently. Distinguish related terms such as “accuracy,” “precision,” “validity,” “reliability,” “model performance,” and “generalization.” Use one term consistently unless a real distinction is intended.

Abbreviations should be expanded at first use: “natural language processing (NLP).” Avoid excessive abbreviations in titles and abstracts. Technical nouns should not replace explanation. “The implementation operationalizes a multi-stage optimization paradigm” is less clear than “The system trains the model in three optimization stages.”

4.2 Voice, tense, and modality

Active voice often makes responsibility clear: “We evaluated three models.” Passive voice can be suitable when the procedure is more important than the actor: “The samples were anonymized.” Neither voice is universally superior.

Use past tense for completed procedures and observations, present tense for established knowledge and statements about the document. Modals such as “may,” “suggests,” and “is consistent with” communicate uncertainty. They should not be used to make vague writing appear academic.

4.3 Quantities, notation, and figures

Report units, denominators, sample sizes, and definitions. Percentages should indicate what they are percentages of. Rounding should be consistent and should not imply greater precision than the measurement supports. Mathematical notation must be defined before or immediately after use. In a classification report, for example, “precision” and “recall” should be defined according to the chosen positive class and evaluation context.

Every figure should have a purpose. A graph should make a pattern easier to see, not merely decorate the document. Axes require labels and units; legends should be readable; color choices should support accessibility, including readers with color-vision deficiencies.

5. Citations, Referencing, and Plagiarism Prevention

5.1 Why citations matter

Citations acknowledge intellectual sources, allow verification, support claims, and place the work in scholarly context. Cite ideas, data, methods, distinctive terminology, direct quotations, and claims that are not common knowledge. The required style—such as APA, IEEE, or another institutional style—must be applied consistently.

A citation is not evidence of quality by itself. The writer must ensure that the cited source actually supports the claim. Citation laundering occurs when a source is cited as if it supports a statement that it does not make. Secondary sources should not be presented as primary evidence when the original source is available and relevant.

5.2 Paraphrasing and quotation

A paraphrase restates an idea in genuinely new wording and sentence structure while preserving the original meaning and providing a citation. Changing a few words in the original sentence is not adequate paraphrasing. Direct quotations should be limited to wording whose exact form matters, placed in quotation marks, and accompanied by precise source information when required.

A practical method is to read the source, close it, write the idea from understanding, and then compare the result with the source for accuracy. Notes should distinguish copied wording from personal interpretation. Reference-management software can reduce clerical errors but cannot judge whether a citation is intellectually appropriate.

5.3 Forms of academic misconduct

Plagiarism includes presenting another person’s words, ideas, data, code, images, or structure as one’s own. Other misconduct includes fabrication of data, falsification or selective alteration of results, duplicate publication, unauthorized collaboration, and misleading authorship. Self-plagiarism can arise when substantial earlier work is reused without disclosure, depending on institutional and publication rules.

Similarity-detection tools identify textual overlap; they do not determine intent or establish plagiarism by themselves. Proper attribution and original intellectual work remain the writer’s responsibility.

6. Reports, Theses, Documentation, and Executive Summaries

6.1 Technical reports

A technical report should enable a sponsor, supervisor, or engineering team to understand what was investigated, what was found, and what action is recommended. A typical structure includes an executive summary, background, requirements or problem definition, methods, findings, risks, recommendations, references, and appendices. Recommendations should be traceable to findings and should state constraints, costs, dependencies, or risks where relevant.

6.2 Theses and dissertations

A bachelor’s thesis normally demonstrates a bounded research project, command of relevant literature, appropriate method, analysis, and independent interpretation. The thesis should have a consistent research question across its introduction, methods, results, and conclusion. Appendices may contain questionnaires, code excerpts, extended tables, or supplementary tests, but essential reasoning should remain in the main text.

6.3 Software and model documentation

AI projects require documentation beyond a research paper. Useful artifacts include:

  • a README explaining purpose, installation, usage, and limitations;
  • an API or function reference;
  • data documentation describing provenance, fields, licensing, missingness, and known bias;
  • a model card describing intended use, evaluation data, performance, limitations, and risks;
  • a change log recording versions and significant modifications;
  • reproducibility information covering dependencies, random seeds where relevant, and execution instructions.

Documentation should distinguish intended use from prohibited or unsafe use. It should not imply that a model is suitable for high-stakes decisions merely because it performs well on a benchmark.

6.4 Executive summaries

An executive summary is written for decision-makers who may not read the full report. It should state the problem, principal finding, significance, recommendation, resources or risks, and proposed action. It should be concise but not promotional. Technical details belong in the report unless they are essential to the decision.

7. Applied Case: Reporting a Credit-Risk Model

This is an illustrative case, not a report of a real institution.

Background and problem

A student research team develops a model to identify loan applications requiring additional review. The team initially plans to report accuracy as the principal measure because it is familiar to non-specialist stakeholders.

Analysis

The dataset contains substantially more low-risk than high-risk applications. Consequently, a model that predicts the majority class for nearly every case could obtain high accuracy while failing to identify risky applications. The team therefore reframes the evaluation around the operational objective: identifying high-risk cases without creating an unmanageable number of false alarms.

The team defines the positive class, separates development data from a final test set, and ensures that preprocessing is fitted only on training data. It compares a transparent logistic-regression baseline with a tree-based model. It reports precision, recall, F1 score, a confusion matrix, and calibration results. It also examines performance across relevant applicant groups, subject to lawful and ethical data use.

Approach and reporting

The methods section records the data period, exclusion criteria, features, missing-value treatment, model versions, threshold-selection procedure, and evaluation protocol. The results section reports performance on the untouched test set. The discussion explains that increased recall may support risk screening but can increase manual-review workload. It also states that the model is not a final lending decision-maker and that historical data may encode unfair patterns.

Outcome

The final report recommends a limited pilot in which model outputs support trained human reviewers. It does not recommend automatic rejection. The recommendation includes monitoring for drift, subgroup performance, calibration, appeal procedures, and periodic review.

Learning points

The case demonstrates that writing influences system governance. Choosing a metric, defining a population, describing a limitation, and framing a recommendation are not merely stylistic decisions. They determine how evidence is interpreted and how technology may be used.

8. Ethical, Governance, and Contemporary Issues

Technical writers have a duty to communicate risks that could affect individuals or communities. In AI, relevant issues include privacy, consent, data licensing, bias, explainability, security, accessibility, environmental cost, and automation-related harm. Writers should disclose conflicts of interest, funding sources where required, use of human participants, and relevant approvals.

AI writing tools can assist with brainstorming, grammar, translation, outlining, and code explanation. However, generated text may contain fabricated citations, inaccurate claims, hidden bias, or confidential-data leakage. Students and researchers remain responsible for verification, originality, and compliance with institutional policy. AI assistance should not replace reading sources, conducting analysis, or acknowledging contributions when disclosure is required.

Contemporary scholarly communication increasingly includes preregistration, open data and code where ethically and legally possible, persistent identifiers, registered reports, transparent reporting checklists, and machine-readable documentation. These practices improve discoverability and reproducibility but do not remove the need for human judgment. Open publication must still protect privacy, intellectual property, and vulnerable participants.

9. Best-Practice Checklist

Before submission, a writer should ask:

  • Is the research question explicit and answered?
  • Does every major claim have appropriate evidence or reasoning?
  • Are methods sufficiently detailed for evaluation or replication?
  • Are training, validation, and test data clearly distinguished?
  • Are results separated from interpretation?
  • Are limitations specific rather than ceremonial?
  • Are terms, units, abbreviations, tables, and figures consistent?
  • Does each citation support the claim for which it is used?
  • Have all borrowed words, ideas, data, code, and images been credited?
  • Are privacy, bias, safety, and conflicts of interest addressed?
  • Has the document been reviewed for audience, clarity, accessibility, and formatting?

Chapter Summary

Technical and academic writing communicates research as a defensible, coherent argument. Effective documents align purpose, audience, genre, evidence, and style. Research papers commonly use an architecture consisting of an abstract, introduction, related work, methods, results, discussion, and conclusion, although the exact structure varies by genre. The introduction establishes the problem and contribution; related work synthesizes prior knowledge; methods support evaluation and replication; results report evidence; discussion interprets significance and limitations; and conclusions answer the research question without introducing new claims.

Clear terminology, controlled sentence structure, appropriate figures, consistent notation, and careful citation improve reliability. Paraphrasing requires genuine re-expression and attribution, while plagiarism, fabrication, falsification, and misleading authorship undermine scholarship. Reports, theses, documentation, and executive summaries adapt the same principles to different audiences and decisions. In AI and ML, documentation must also address data provenance, intended use, performance limits, fairness, privacy, safety, and monitoring. AI-assisted writing may support communication, but human authors remain accountable for truth, originality, and ethical practice.

Key Terms

Academic writing: Formal communication intended to develop, examine, or transmit scholarly knowledge.

Abstract: A self-contained summary of a research document.

Audience: The intended readers whose knowledge and needs shape the writing.

Claim: A statement asserted by the writer and requiring support or qualification.

Coherence: The logical connection among ideas across sentences and sections.

Contribution: The specific addition a work makes to knowledge, practice, data, method, or theory.

Discussion: The section that interprets findings and considers implications and limitations.

Executive summary: A concise decision-oriented overview of a longer report.

IMRaD: The conventional structure of Introduction, Methods, Results, and Discussion.

Methodology: The rationale and framework guiding the choice and use of research methods.

Paraphrase: A restatement of a source’s meaning in original wording with attribution.

Plagiarism: Presenting another’s words, ideas, data, code, or other work as one’s own.

Reproducibility: The ability to obtain consistent findings by following documented procedures with the relevant materials.

Related work: A synthesized account of prior research relevant to the present study.

Results: The documented observations or analyses produced by a study.

Signposting: Language that makes the organization or logical relationship of an argument explicit.

Technical writing: Practical, precise communication about systems, procedures, products, or technical findings.

Thesis statement: The central position or answer developed by an academic document.

Validity: The extent to which a study or measure supports the conclusions drawn from it.

Review Questions

Short Answer Questions

1. What are the five central questions that a research document should answer?

2. How does a related-work section differ from a list of article summaries?

3. Distinguish a result from a discussion statement.

4. What makes a paraphrase academically acceptable?

5. Name four types of documentation useful for an AI project.

Long Answer Questions

1. Explain how an introduction can move from broad context to a specific research contribution.

2. Describe the information that should be included in a reproducible methods section for an ML experiment.

3. Discuss how audience and purpose affect the structure and language of a technical report, thesis, and executive summary.

4. Explain why accuracy may be inadequate as the only evaluation measure for an imbalanced classification problem, and describe how this issue should be reported.

5. Discuss the ethical responsibilities of an AI researcher when reporting model performance, limitations, and intended use.

Analytical / Application Questions

1. A classifier achieves 97% accuracy on a dataset in which only 3% of cases belong to the positive class. Design a reporting plan that would allow readers to judge whether the model is useful.

2. A student rewrites a paragraph by changing several words but preserves its original sentence structure and omits the citation. Analyze the academic problem and propose a correct alternative.

3. Prepare an outline for a two-page executive summary recommending whether an organization should pilot an AI system for screening applications. Identify the evidence, risks, recommendation, and safeguards that should appear.

Multiple Choice Questions with Answers

Question 1

Which section primarily explains how a study was conducted and enables readers to assess replication?

A. Abstract

B. Methods

C. Discussion

D. Conclusion

Correct Answer: B. Methods

Question 2

What is the main purpose of a related-work section?

A. To list every paper found during searching

B. To provide software installation instructions

C. To synthesize prior research and identify relevant gaps

D. To report the study’s final numerical results

Correct Answer: C. To synthesize prior research and identify relevant gaps

Question 3

Which statement is an interpretation rather than a result?

A. Recall increased from 0.71 to 0.78

B. The test set contained 2,000 observations

C. The model was trained for 50 epochs

D. The recall increase may be useful where missed cases are costly

Correct Answer: D. The recall increase may be useful where missed cases are costly

Question 4

What is required for an academically acceptable paraphrase?

A. Changing only several words in the source

B. Using the source’s sentence structure without quotation marks

C. Restating the idea in genuinely new wording and citing the source

D. Removing the source citation if the wording is different

Correct Answer: C. Restating the idea in genuinely new wording and citing the source

Question 5

Which item is most appropriate for an AI model card?

A. The author’s personal study schedule

B. Intended use, evaluation performance, and known limitations

C. Only the model’s highest benchmark score

D. A list of unrelated literature topics

Correct Answer: B. Intended use, evaluation performance, and known limitations

Question 6

Why can accuracy be misleading for a highly imbalanced classification dataset?

A. Accuracy cannot be calculated for classifiers

B. A majority-class model may appear successful while missing most positive cases

C. Accuracy always measures calibration instead of classification

D. Accuracy is defined only for regression problems

Correct Answer: B. A majority-class model may appear successful while missing most positive cases

Question 7

Which progression best represents a coherent research argument?

A. Claim, evidence, reasoning, qualification

B. Citation, title, abbreviation, appendix

C. Opinion, advertisement, repetition, conclusion

D. Figure, footnote, glossary, title

Correct Answer: A. Claim, evidence, reasoning, qualification

Question 8

What should an executive summary primarily provide?

A. Every technical detail in the full report

B. A decision-oriented overview of the problem, findings, risks, and recommendation

C. Only a bibliography of sources

D. Unverified promotional claims

Correct Answer: B. A decision-oriented overview of the problem, findings, risks, and recommendation

Question 9

Which practice best protects against data leakage in an ML evaluation?

A. Fitting preprocessing transformations using the test set

B. Selecting the final model after repeatedly inspecting test performance

C. Fitting preprocessing on training data and applying it to held-out data

D. Combining training and test labels before model development

Correct Answer: C. Fitting preprocessing on training data and applying it to held-out data

Question 10

What is a major responsibility when using AI-assisted writing tools?

A. Accepting generated citations without checking them

B. Allowing the tool to determine the research conclusion

C. Verifying accuracy, originality, confidentiality, and policy compliance

D. Removing all human review from the writing process

Correct Answer: C. Verifying accuracy, originality, confidentiality, and policy compliance

Research Methodology & Technical Writing
Chapter 12 of 14