When you have completed drafting your manual, read it again to revise the contents
to check if needs further revision. Make use of the following checklist:
Check your use of language to ensure that effectiveness and readability have been
achieved. This section concerns the style of language that you should use in writing
various parts of a user manual.
Preciseness in instructions
Leave no room for unnecessary speculation of instructions or explanations. Pay
special attention to the use of modal verbs. See table below for reference.
Meanings of different modal verbs: a quick guide for user manual writing
2
Bulleting and Numbering
Present lists of items vertically and bullet each item on a list. e.g.,
The proc routine returns and error 300 to the main program
under either of the following conditions:
• the record control field does not contain an X,Y or Z.
• the control word does not indicate the expected file
type.
1. Press <F4>.
2. Press <F2>.
3. Press <enter>.
4. Press <F2>.
5. Press <enter>.
Don’t forget to supply a key to the symbols and conventions used in the preface.
3
Section VII -- Tasks File
a. After the operator has set appropriate flags, he can enter the debug mode.
b. After the user has set appropriate flags, he/she can enter the debug mode.
c. After the users have set appropriate flags, they can enter the debug mode.
d. After setting the appropriate flags, you can enter the debug mode.
4
Task 5 Ensuring readability of long list of items
Decide which writing style in the following pair of paragraphs is a
better choice. 1a or 1b? Justify your answers.
1.a. When the PROC routine reads a record with a control field that
does not contain an X, Y, or Z, or in which that control word does
not indicate the expected file type, the routine returns an error
300 to the main program, which in turn displays the message text
and aborts the job.
1.b. The PROC routine returns and error 300 to the main program
under either of the following conditions:
•
the record control field does not contain an X, Y, or Z.
•
The control word does not indicate the expected file
type.
The main program in turn displays the error 300 message and
aborts the job.
Writer 1
Columns 1 through 5 are reserved for optional statement numbers. Statement
numbers are not required, but if used, they cannot be duplicated within the
program. Statement numbers need not appear in ascending numeric sequence.
A maximum of 200 statement numbers can be used in one program. Statement
number positioning is shown in figure 9-3.
Writer 2
The directive portion of a statement can appear in columns 6-65. If a
statement exceeds column 65, you can continue the statement in column 6 of
the next line. When you continue a directive, you must include an asterisk (*)
in column 1 of the continued line. (Please refer to diagram 9-4).
2a. Now you can save your work on several other discs just in case.
b. Now you should save your work on at least one other disc in case of any
damages to the original one.
c. Now save your work on at least one other disc in case ....
5
Checklists for your first draft
Contents
Items Yes No Revisions to make
Is there any ambiguity or mistakes in
any of your explanations or instructions,
including those in the appendices?
Is there any unnecessary repetition which
reduces the conciseness of your writing? Are
there any bugs in the instructions?
Are the responses accurately described?
Have all essential cautions and warnings
been included?
Is there any important information missing,
including essential graphics, cross-
referencing and headings?
What revisions need to be made in the Table
of Contents?
Language editing
Items Yes No Revisions to make
Have I used the you-tone effectively?
Have I used imperatives properly in
instructions?
Have I used simple and short sentences
throughout?
Have I used non-sexist language?
Have I used consistent language throughout?
(terms and tone)
Have I bulleted non-step lists?
Have I used enough graphics?
Have I labelled and referred to all graphics?