AW: [wp-docs] Wiki
Cena
cena at cox-internet.com
Mon Dec 29 13:40:37 CST 2003
Christian wrote:
PPP.SSS.: Before I forget about it: Keep the docs short and simple. People will
have to read it, and overdocumentation is as bad as no documentation...
Craig wrote:
** It will always be a challenge to find the right balance for this. Some will
want exhaustive explanations of things, while others are satisfied with
overviews. I think that each bit of documentation will have to be examined for
lack of or excessiveness of detail.**
I agree. Obviously docs intended for newbies aren't appropriate for
more advanced users, and vice versa. However, instead of writing two
sets of docs (theoretically), why not just set up a format for docs such as:
Abstract
Intended Audience (including a declaration of what level of reader
knowledge/skillset is assumed by the author
TOC (if necessary)
(body of doc)
Bibliography/Sources (if necessary)
That way a reader knows right away 'who' it's for. Also, if it's a very
comprehensive doc detailing many different aspect of a particular WP
process, then why not just include an 'Advanced Users' section for more
detailed discussions?
More information about the docs
mailing list