Re: My first doc

[Judith Samson <judith samson usaserve net>]

The organization of any document mainly depends on two criteria: 1)Who your audience is and 2) What the
purpose of your document is.

If you are writing a user manual or tutorial, I find that it is usually best to order your material in a
way that the reader would actually use it--maybe one chapter for each task  You can also make an index
of each function at the end for reference.

If you are writing a reference doc for people already basically familiar with the app, you can list each
function by menu or alphabetically, depending on the app.

EarthTone is working on the GNOME Handbook of Writing Software Documentation, which should help.

Owen Williams wrote:

> I would like to write documentation for one of my favorite apps, gFTP.  I've started reading about
> DocBook, but I would also like to know how the manual should be structured.  gftp is a very large
> and powerful program, and I was wondering if there were any recommendations / requirements for
> organizing all of the functions.  Would it be by menu item,  or by what a user would want to do,  or
> some other method?
>
> Owen Williams
>
> --
>         FAQ: Frequently-Asked Questions at http://www.gnome.org/gnomefaq
>          To unsubscribe: mail gnome-doc-list-request@gnome.org with
>                        "unsubscribe" as the Subject.