Create an outline of your
manual. Separate the sections as required:
a.
A cover page
b.
A preface, containing details of related documents and
information on how to navigate the user guide; a preliminary introduction that
explains its scope, intention, or background.
c.
A Table of Contents page (headings and subheadings)
(index)
d.
A step by step GUIDE on how to use at least the main
functions of the system/technical procedure/instructions/what is
required/screenshots/figures, etc
e.
A troubleshooting section detailing possible errors or
problems that may occur, along with how to fix them
f.
Where to find further help, and contact details
g.
A glossary
No hay comentarios:
Publicar un comentario