Chapter 4 — Academic writing | Bachelor's Network and communications security

Open, free learning for anyone who wants to protect people and technology. No account is required to read this text or its worked answers.

Lesson map

Lesson 04 published. Map, example, EX010.

flowchart TD
  N0["Learning outcomes"]
  N1["4.1 Writing for a reader"]
  N2["4.2 Citing sources"]
  N3["4.3 Report structure"]
  N4["4.4 Revising"]
  N5["Synthesis"]
  N0 --> N1 --> N2 --> N3 --> N4 --> N5
  N5 --> EX["Worked example"]
  EX --> Q["Exercise EX010"]

Logical drawing

flowchart LR
  N0["Learning outcomes"]
  N1["4.1 Writing for a reader"]
  N2["4.2 Citing sources"]
  N3["4.3 Report structure"]
  N4["4.4 Revising"]
  N5["Synthesis"]
  N0 --> N1 --> N2 --> N3 --> N4 --> N5 --> Q["EX010"]

[Learning outcomes]
    |
    v
[4.1 Writing for a reader]
    |
    v
[4.2 Citing sources]
    |
    v
[4.3 Report structure]
    |
    v
[4.4 Revising]
    |
    v
[Synthesis]
    |
    v
[Worked example] --> [Exercise EX010]

Learning outcomes

You will (1) write clear technical prose; (2) cite sources accurately; (3) structure a short report.

4.1 Writing for a reader

Priya's first assignment is a two-page report on wireless risks at a small clinic. Her tutor explains that technical writing serves a reader with limited time: state the main point first, then the evidence, then the detail. Each paragraph should make one point, and each sentence should be easy to follow on first reading. Jargon is defined the first time it appears or avoided. A clinic manager reading the report should understand the risk and the recommendation from the first paragraph, even if they skip the rest.

4.2 Citing sources

Claims that come from others must be cited, and citations must be accurate. Priya cites NIST SP 800-153, the guidelines for securing wireless local area networks, when describing separation of wireless networks, and checks the title, number and year against the document itself. She learns to prefer primary sources, such as standards and peer-reviewed papers, over summaries. A citation lets readers check a claim, so a wrong number or title wastes their time and damages the writer's credibility. Every citation in this course comes from the verified reference list.

4.3 Report structure

A short technical report usually contains a summary, background, findings, recommendations and references. Findings state what was observed with evidence; recommendations state what should change, who should do it and why. Priya keeps findings and opinions separate: "visitor phones joined the same network as clinical carts" is a finding, while "this is unacceptable" is an opinion that needs justification. This separation lets readers accept the evidence even if they weigh the risk differently, and it makes the report easier to act on.

4.4 Revising

First drafts are rarely clear. Priya revises by reading the report aloud, cutting sentences that repeat earlier points, and checking that each recommendation follows from a finding. She asks a classmate to summarise the report after one reading; if the summary differs from her intended main point, the report needs work. Revision takes as long as drafting, but it is where most of the improvement happens. Good writing matters in security because recommendations that are not understood are not acted on, however correct they are.

Worked example

Priya's revised summary reads: "All four clinics use one wireless network for visitors, staff and clinical devices. We recommend separate networks for each group, starting with visitors."

Synthetic case. The report and clinics are synthetic.

Errors and limits

Citations copied from other documents without checking often contain errors.

Exercises

EX010 — Finding versus opinion. Classify "the clinic's wireless design is dangerous" and rewrite it as a finding.
Show marking criteria
Rubric: 3 = opinion; rewritten as an observed fact with evidence;; 2 = opinion;; 1 = rewrites without classifying;; 0 = none.
EX011 — Primary source preference. Why prefer a NIST publication to a blog summary of it?
Show marking criteria
Rubric: 3 = primary, accurate, checkable;; 2 = more reliable;; 1 = vague;; 0 = none.
EX012 — Summary test. How can a classmate help test a report's clarity?
Show marking criteria
Rubric: 3 = summarise after one read, compare with intended point;; 2 = read it;; 1 = proofread;; 0 = none.

Synthesis

Clear structure, accurate citations and revision make technical writing useful to its readers.

Continue studying — chapter 04 of 40

← Chapter 03 (draft) · Course chapter index · Chapter 05 (draft) →