All annotations are sensibly placed and refer to terminology used throughout the rest of the document. Language mechanics Grammar, spelling, capitalisation, punctuation and sentence structure are correct and consistent. Sentences are short, clear and concise. Instructional information is in the active voice. Language style Predefined house style is followed.
Tone is consistent and the flow of text ensures ready comprehension.
This list isn't exhaustive but does give a flavour of some of the factors that need to be considered throughout the writing process. The list could even be adapted to form the basis of a 'documentation task checklist'. Technical Writing Specializing in all types of written solutions including user guides, online help systems, training courseware, quick start cards, web content development, and graphics. Get FREE writing tips and business reading and speaking skills information. See our on-line courses and workbooks.