[Ansteorra] The Journey: A&S

Christie Ward val_org at hotmail.com
Wed Apr 17 15:00:49 PDT 2002


Maria asked:
>So, this leads me to ask....What makes for good
>documentation? How do you write documentation? I've not entered anything
>because I know nothing about writing
>documentation. When I have asked, the only answers I get are vague and
>confusing.

Before I say anything else, here's a caveat -- we don't have one unified
standard of What Good Documentation Consists Of.  It's like Goldilocks and
the bears -- some Laurels want a big bunch of hot documentation, some want a
medium amount of documentation, and some want the bare minimum and think
that less is "just right".

That being said, I advocate a kind of middle ground as to how much and in
what depth -- I tend to suggest a single summary page, followed by the rest
of yoru documentation, which allows you to please people through the whole
spectrum.

I've often maintained that the basic documentation needed could be typed on
one of those large 5"x8" index cards.  And I one time wrote up Gunnora's
Theory of Documentation, which Stefan li Rous has kindly made available
through his Florilegium files at:

http://www.florilegium.org/files/CELEBRATIONS/5x8-Doc-art.html

::GUNNORA::

_________________________________________________________________
Join the world’s largest e-mail service with MSN Hotmail.
http://www.hotmail.com




More information about the Ansteorra mailing list