Menu

Forms of Notation

Effective written information

Effective written information is text that a reader can understand and use straight away. It is clear, accurate, concise and written for its intended audience, so it does the job without making the reader work hard to find the point.

Clear and accurate

Accurate written information has facts and figures that are correct and consistent with any tables it refers to. If a report says the oldest item in stock is a batch of 40 cables, the stock table must show the same number. Wrong figures destroy trust and can lead to poor decisions.

Concise means including only what the reader needs. A long document buries the main point, so short paragraphs and focused sentences are easier to act on. Length is not a sign of quality; padding wastes the reader's time.

Use correct terminology properly and consistently. Words such as backup, firewall and encryption have exact meanings, so use them the same way throughout. A backup is a copy of data kept so it can be restored; calling any saved file a backup confuses the reader.

Structure and audience

A logical structure helps readers follow the writing: headings show what each section covers, paragraphs group related sentences, and bullet points break a list of steps or features into easy pieces. A reader can then scan to the part they need.

Audience awareness means matching the language to the reader. For a client or a new member of staff, use plain words and explain any technical term the first time it appears. Use specialised terms only where the reader will understand them; a technician may know what a firewall does, but a new volunteer may not.

For example, a short guide for new club volunteers might say: "Before locking up, copy the register to the shared drive. This backup means the list can be restored if a laptop fails." It is brief, uses backup correctly, and explains why the step matters.

Practise this