[documentation] Documentation, Module Maintainers, Documentation Maintainers, and Documentation Templates
pyutaros at idkd.net
pyutaros at idkd.net
Thu May 10 19:44:47 UTC 2007
Hi all. I recently put this post (http://drupal.org/node/142483) in the
documentation forum. It's mostly about creating a documentation template
for contributed modules, but it also suggests the idea of having
documentation maintainers who work alongside module maintainers. Check it
out if you have time. Here is my suggestion for a documentation template.
Thanks for your time in reviewing this.
1) Front Page - (Preferrably straight out of the README.txt)
a - Intro
b - Rationale (Why use it, feature comparison to other Drupal functions)
c - Prerequisites (Other modules that need be installed first, plugins,
addins)
d - Coming Soon section (Requested write-ups from the comments section)
2) Child - Installation (Preferrably straight out of the INSTALL.txt)
3) Child - Admin pages explained
4) Child - Special permissions explained
5) Child - Listing of installed modules and submodules and functions
6) Child - Table structure
7) Child - FAQ (Drawn from the module's issue queue and from comments.)
8) Child - REAL EXAMPLES (Things people have done with the module, sites
using it?)
There are a couple others that I think I like but I'm not so solid on.
1) Child - Actual code from each file in the module directory. Each file
gets a child page of this page. (I know this could get ridiculous for some
modules) The nice thing about this in my opinion is that the code gets
indexed by the search engine.
2) Child - Advanced user section.
More information about the documentation
mailing list