Re: [Gnumeric] Screenshots in Gnumeric Docs.

[Chris Lyttle <chris wilddev net>]

On 15 Mar 2002, Alexander Kirillov wrote:

> My humble opinion:
>
> a. 300 hundred shots is excessive - but I do think that whenever you are
> documenting, e.g. a configuration dialog, you need a shot of it. Do not
> forget, our docs will not only be read as online help - sometimes they
> are printed out, or included in printed manuals. But it is not a really
> important point 
>
> b. We do need both "task oriented" manual, or "how-to"s (which do not
> have to cover all possible options) and a *complete* reference, listing
> all menu commands, all options in all dialogs, etc,  with an index. We
> shouldn't try to cover both of these goals in a single document. 
>
> Typically you do not search docs for "what this menu item does"; you try
> to find "is there a way to do this?" - and the best way to find an
> answer to this is to use an index. BTW, an index is supposed to be
> produced automatically form <indexterm> tags in the body of the document
> - so we must start adding these tags now.  
>
> Also: the "task oriented", or "how-to" type of document can (and should)
> link to the "reference" part, e.g. 
>
> ... for full description of printing options, see Section #.# of the
> Reference Manual
>
> Kevin: if you could write down a "global" outline of docs: "task
> oriented", reference, short intro, etc, then me (and other people) could
> could do parts of it.  
>
> Sasha
A quick scan thru the GDP Style Guide didn't seem to turn up at least the 
tidbit on indexing, can we get get this in the Style Guide?

Chris