Monday 24 October 2016

Writing Styles: How to Write a Guide

Writing Styles: How to Write a Guide




Before writing a guide on how to do something, there are a couple of questions that you need to ask yourself: 

Do you know the subject well enough to explain it in simple terms, and can you write a concise set of instructions based on that explanation?

Keep It Simple.




This document introduces five basic principles about writing instructions for a guide:
  •   Know your audience -who is the guide for?
  •    Provide a brief introduction - a title and sub-title
  •    Write each step as a command - 1, 2, 3, 4, etc.
  •    Use numbers for commands, bullets for options - 1, followed by a bullet point, etc.
  •   Test your draft, mark for corrections and print a final copy. (you can add pictures if it will help support your guide)

1.    Know your audience. Your writing must be clear enough that readers can understand with minimal effort. This does not mean using baby language or avoiding complex details; it does mean using vocabulary appropriate to your audience, and including details that your readers need to perform the immediate task.

2.    Provide a brief introduction. Help your readers determine, even before opening the brochure, whether this document will help them do whatever it is they want to do.

State in plain language, what task your document describes: For example, Top 10 Ways to Survive a Zombie Apocalypse"

In a few sentences, state the purpose of the document; who should read it, and under what circumstances? If it will help your reader, you might also explain what your document does not do.

For example, “This step-by-step guide will help you survive the living dead in just 10 easy steps."

3.    Write each step as a command. Phrase each step as if your reader has just asked, “What should I do next?” Answer by giving a direct command: “Build Tall and Sturdy Walls.”

For example, 

When you are describing steps that must be completed in a certain order, common sense insists that you start with the first step. Number each step, in order to emphasise the sequence.

Note: when you are providing a list of possibilities  which do not have to come in any particular order, use bullets instead of numbers.


Here’s an example of a guide that gives instructions: Note the FEATURES of this Guide:

Have a title. Say what the guide is; and who it is for - include these features in your guide. 
  
4. Use numbers for commands, bullets for options. Divide up your instructions

Write brief introductions to each section, to clarify whether a list of steps is supposed to be sequential or optional.



Here is a list of features for this guide about surviving a zombie apocalypse

Title: "Top 10 Ways to Survive a Zombie Apocalypse"

What is it?  "It's a Simple Guide to Help You Survive the Living Dead"

It has 10 suggestions.  Each suggestion is numbered; followed by a brief, emboldened title with bullet points beneath that provides further information.

Conclusion: "Keep vigilant!"
Pictures are provided to support the GUIDE. 

Here, let's break it down even further:




Another example based on the Lime and the Coconut Song (Google it, if you want to know) - note the FEATURES that make this a GUIDE. 


No comments:

Post a Comment