 | I would like to see your UM divided into two parts: a tutorial part and a
reference part. |
| The tutorial part should use an extended example which exercises most (at
least the most common) functions in your software. Typically, if a function
as several options, your example should demonstrate some of them. The
tutorial should include screen shots of your application to support the
narrative text. If you application is not yet suitable for producing screen
shots, then just produce the narrative text as you expect the application to
operate and leave place holders (empty figures) for the screen shots. You do
not need to draw figures to replace anticipated screen shots; however, your
narrative text may need to more precise to convey a meaningful message in
their absence. |
| It is acceptable, though not required, to replace the tutorial part of the
UM with a web-based tutorial. |
| The reference part should be organized according to function. For
example: assuming you have a typical menu bar, you would cover all the "File"
menu options in one section, the "Edit" options in another. I suggest using
the linux man page format for these reference pages, e.g.,
 | Command name and synopsis |
| Description of command and options |
| Examples |
| Related commands or functions |
| Footnotes (if applicable) |
|
| There is no length requirement for the UM (or the maintenance manual or
installation manual for that matter), as long at it reasonably covers the
ideas above. |