2.3k questions

2.3k answers

91.5k users

2 Online Users
0 Member 2 Guest
Today Visits : 585
Yesterday Visits : 1322
Total Visits : 2231614

Categories

Notice

Dear All, These are my answers from Quora and primarily Google; please check the answer and from others sites; the answers are free and without any liability.To make a decision, write down all of the positives and negatives on a piece of paper.Thank you,

Elias Katsaniotis, MSc

Information

Viktoria Katsanioti,

Kaliningrad,

Russia,

matizegr@yahoo.com

0 votes
45 views

How do I prepare a user manual document?
in General by (91.9k points)

1 Answer

0 votes

It depends on who is going to read.

You must speak the language of the readers, write according to the level of knowledge of the readers.

Imagine a Person who is the Reader, what how knows ? what he must learn ? e.t.c.

The language must be simple, and accurate, to use images and diagrams.

For the structure see othr similar manuals.

Someone else must read the manual and suggest corrections.

google says: How do you create a user document?

Tips For Writing Better User Documentation

  1. Start With A Plan. ...
  2. Write in Plain Language. ...
  3. Use Visuals to Speed Up Understanding. ...
  4. Break Complex Tasks Into Simple Steps. ...
  5. Follow a Hierarchy That Makes Sense. ...
  6. Make It Searchable. ...
  7. Include a Table of Contents. ...
  8. Test, Analyse & Reiterate
by (91.9k points)
...