[documentation] Contrib module documentation

["Fernando P. García"]

About contrib modules documentation, you mentin modules home page, 
README.txt and help page, don't forget the built-in hook_help.
I have the idea to load README.txt into hook_help, so that is is more 
accesible. What do you think?

Blessings!

On Tue, Aug 5, 2008 at 5:52 AM, Erik Stielstra <info at erikstielstra.nl 
<mailto:info at erikstielstra.nl>> wrote:

    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



    --
    Pending work: http://drupal.org/project/issues/documentation/
    List archives: http://lists.drupal.org/pipermail/documentation/




-- 
Fernando P. García, http://www.develcuy.com
Developer - Analista de Sistemas
+51 1 9 8991 7871, Mz. P Lt. 30 1et Urb. Pachacamac - VES, Lima - Perú

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20080805/4f377c6c/attachment-0001.htm