<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body bgcolor="#ffffff" text="#000000">
<div dir="ltr">About contrib modules documentation, you mentin modules
home page, README.txt and help page, don't forget the built-in
hook_help.<br>
I have the idea to load README.txt into hook_help, so that is is more
accesible. What do you think?<br>
<br>
Blessings!<br>
<br>
<div class="gmail_quote">On Tue, Aug 5, 2008 at 5:52 AM, Erik Stielstra
<span dir="ltr"><<a href="mailto:info@erikstielstra.nl">info@erikstielstra.nl</a>></span>
wrote:<br>
<blockquote class="gmail_quote"
style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">For
my presentation at DrupalCon (<a
href="http://szeged2008.drupalcon.org/program/sessions/contrib-module-usability"
target="_blank">http://szeged2008.drupalcon.org/program/sessions/contrib-module-usability</a><br>
) I am reviewing the way module maintainers document their module.<br>
I.m.o. one of the bigger problems is that module maintainers take care<br>
of details but forget to explain the bigger picture. Additionally the<br>
available documentation channels (see below) are used differently by<br>
different maintainers. As a result site admins and developers have to<br>
look in different places for their information and often have to wade<br>
through details and only learn the module's concept by trial and error.<br>
<br>
Module maintainers can document their modules in different places:<br>
* module's project page<br>
* module's README.txt file<br>
* Module's help page<br>
* The handbook under Contributed modules (<a
href="http://drupal.org/handbook/config/contribmodules" target="_blank">http://drupal.org/handbook/config/contribmodules</a><br>
)<br>
<br>
Are there any guidelines on what means to use for what purpose?<br>
The only thing I found is the 'Drupal Module Documentation<br>
Recommendations' (<a href="http://drupal.org/node/161085"
target="_blank">http://drupal.org/node/161085</a>)<br>
<br>
Erik Stielstra<br>
<font color="#888888"><br>
<br>
<br>
--<br>
Pending work: <a href="http://drupal.org/project/issues/documentation/"
target="_blank">http://drupal.org/project/issues/documentation/</a><br>
List archives: <a
href="http://lists.drupal.org/pipermail/documentation/" target="_blank">http://lists.drupal.org/pipermail/documentation/</a><br>
</font></blockquote>
</div>
<br>
<br clear="all">
<br>
-- <br>
Fernando P. García, <a href="http://www.develcuy.com">http://www.develcuy.com</a><br>
Developer - Analista de Sistemas<br>
+51 1 9 8991 7871, Mz. P Lt. 30 1et Urb. Pachacamac - VES, Lima - Perú<br>
<br>
</div>
</body>
</html>