[drupal-docs] Regarding the drupal help documentation

[Kieran Lal]

On May 10, 2005, at 2:39 PM, Dan Robinson wrote:

> I have looked through everything I
> have been pointed at and still have yet to see a clear description of
> who the reader is and what the goals and objectives of this exercise
> is.

1. Get admin/help text written for all 60 modules.
2. Improve the usability of Drupal by having consistent help text for  
all 60 modules.  In this case consistent means short, and scannable.
3. Provide links in admin/help to the new configuration and  
customization handbook page for each of the 60 modules.
4. Provide links to the administration interfaces for each module  
where appropriate. This will improve the users ability to learn the  
system, increase their ability to explore, and reduce errors for the  
task they are trying to accomplish.

Help text template
Intro Paragraph-benefits

Task Paragraph-

Links
Link to adminstration
Link to prerequisite configuration /or other associated tasks{Optional}
Link to handbook page

How's that?

Kieran
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050510/81355822/attachment.htm