A user manual is a technical communication document that explains in simple terms how to use the application or a device.
A user manual is combination of words, screenshots, and diagrams etc. The language used matches the intended audience. Jargons are avoided and if used are explained thoroughly.
Contents of a User Manual
• Front Page-Application logo, keywords etc
• Title Page-Title of the manual
• Copyright-copyright notice
• Disclaimer-Terms and condition of using the manual
• Preface-Purpose and scope
• Table of Contents-Topics
• Body of the manual-Heat of the user manual
• Reference Material-can include FAQs, troubleshooting procedure, error messages etc
• Glossary-acronyms and terms used in the manual
• Index- guide to locate specific terms
Good Quote
The role of a writer is not to say what we all can say, but what we are unable to say. ~Anaïs Nin
No comments:
Post a Comment