The state of our documentation on documentation (DOD) is pretty good in 
my opinion.  Not only do we have the most critical documents, including 
templates, but they're in our catalog.

However, I think we need to add a few pieces of DOD just to be on the 
safe side.  I've listed the major tasks I believe we need people to do 
for Documentation, and we might as well have "How-To" guides on these 
topics.

Borrowing from the 3rd draft of our management roadmap:

* Cataloging documentation
   * Searching the old documentation
   * Filing links in the catalog for the documentation
   * Determining what we have no categories for in our catalog, but we 
should have
   * Determining relevant cross-links between categories (what category 
relates to another category)
* Verifying documentation is accurate
* Checking for spelling and grammar errors, and also consistent markup 
style in pages
* Editing out-of-date documentation
* Writing documentation where it's non-existent (search for it first!!)
* Writing documentation for beginners & intermediate people
* Documenting Mozilla source code itself (as output by LXR)
* Triaging Documentation bugs in Bugzilla
* Creating CVS-compatible patches for check-in to mozilla.org or 
uploading them to moz.zope.org (we may do both, undecided yet)
* Reviewing and super-reviewing documentation patches

Keyser Sosez maintains a large part of our catalog, so I asked him to do 
a writeup on the processes of cataloging documentation.  Brian has a bug 
  assigned to him for r=/sr= policy, so that one's being worked on as 
well.  We have a solid style guide for spelling, grammar and markup.

The rest of this, I think we need articles on.  Any volunteers willing 
to write these articles?

Also, are there any other "basics to documentation" that I have missed 
and aren't in our catalog for documentation?

Alex


Reply via email to