[documentation] Contrib module documentation

Erik Stielstra info at erikstielstra.nl
Tue Aug 5 10:52:33 UTC 2008


For my presentation at DrupalCon (http://szeged2008.drupalcon.org/program/sessions/contrib-module-usability 
) I am reviewing the way module maintainers document their module.  
I.m.o. one of the bigger problems is that module maintainers take care  
of details but forget to explain the bigger picture. Additionally  the  
available documentation channels (see below) are used differently by  
different maintainers. As a result site admins and developers have to  
look in different places for their information and often have to wade  
through details and only learn the module's concept by trial and error.

Module maintainers can document their modules in different places:
* module's project page
* module's README.txt file
* Module's help page
* The handbook under Contributed modules (http://drupal.org/handbook/config/contribmodules 
)

Are there any guidelines on what means to use for what purpose?
The only thing I found is the 'Drupal Module Documentation  
Recommendations' (http://drupal.org/node/161085)

Erik Stielstra





More information about the documentation mailing list