Vahur Krouverk wrote:
> 
> [...]
> Writing documentation is hardest part of patch creation  :-), so if
> there are guidelines/templates, then it would be great help.
> Easiest would be to put each patch documentation to separate directory
> and require, that patch-specific index file is in parent directory. This
> way updating various patches documentation would be easy (just replace
> directory and index file). Main documentation would be created by having
> links to separate patches index files (not very user-friendly) or by
> copying patch-specific index files contents to one document (requires
> more work, but has better usability). In latter case it should be agreed
> general layout of index file, so that every part has similar appearance
> (e.g. patch name with header 3, subchapters with header 4, etc).

This is about the concept i have in mind, but i would not force a separate
index file for each patch, especially for small additions this seems
rather complicated and would not improve usability.  Instead it could be
agreed that the structure of the anchor/header tags in the documentation
files is copied into the index.  This would maintain a lot of flexibility
for the authors, they only would have to maintain anchor tags for each
element they want in the index.

Christoph

-- 
POV-Ray tutorials, IsoWood include,                 
TransSkin and more: http://www.tu-bs.de/~y0013390/  
Last updated 14 Apr. 2002 _____./\/^>_*_<^\/\.______

Post a reply to this message