Things necessary for writing a good user manual
- 1. Things necessary for writing a good User Manual The instructions in user manual should map to the actual product in all aspects. Present instructions as step by step procedures. Writer’s should understand the product, and actually use the product as they write. Write the steps to task completion while doing the actual task on the product. Write different user manual for different user profiles. Do not conclude all in one. Use of consistent font and consistent alignment for images. Follow naming conventions (e.g. Step 1, Step 2 etc). The user manual text should be in Present tense. Define who your user is: Do a user analysis, based on the role of the user, write a manual explaining the role of that particular user in detail. Write to your user need in a way the user can understand: Language, Terminologies. Avoid using highly technical language. Do not assume the user has prior product knowledge or experience: Start the explanation from the scratch. Explain the problem the user might face, then present the solution: Identify the problem a user might face, in case of complex problem break down it into smaller chunks, and then follow with each chunk in succession. Use graphic images to support the text: Graphic images or screenshots can illustrate certain points in manual better then text. Make references to images or figure: It is important to mention the reference in a text (e.g. Fig 01) for better understanding of user. Avoid unnecessary cross referencing to other parts of the user manual unless needed. Abbreviations and Technical Terms: Include a table at the beginning of the user manual, stating the full forms of each abbreviations used in the user manual. Provide a glossary of technical terms for users understanding. Avoid lengthy Paragraphs: The information should be concise and to the point. User Manual Layout: Put Manual’s Title and other details in Header and Footer of the page