[documentation] A suggestion to improve drupal.org handbooks

[Kieran Lal]

On Jan 19, 2006, at 11:20 AM, gunnar wrote:

> Laura - that (below) was exactly my point in my previous post.
> A standard structure (maybe just guidelines) would help developers  
> document
> their modules. Also other document writers might have a better  
> chance of
> stepping in and "filling in the blanks".
>
> So  - maybe not for now but for later - should we try and decide on  
> a format?

The project form is listed below.  Certainly you could update the  
form, but the real challenge is getting it filled out.  Giving  
developers better tools is a good idea.  Expecting them to stop  
coding to make time for documentation is a bit of a losing battle.  I  
would recommend pursuing a strategy that involves less planning and  
more elbow grease.

Here's the modules checked into Drupal CVS: http://cvs.drupal.org/ 
viewcvs/drupal/contributions/modules/.  Here's the modules project  
page: http://drupal.org/project/Modules.  That list is significantly  
smaller.  An even smaller list is: http://drupal.org/handbook/modules

Planning is good, documentation contributions is even better.  Let me  
know how I can help.

Cheers,
Kieran

Full project name:*
Full description:*
Input format

Short project name:*
This will be used to generate a /project/<shortname>/ URL for your  
project.
Project e-mail:*
E-mail address where the project owners can be contacted.
Homepage:
Link to project homepage.
Documentation:
Link to project documentation.
License:
Link to project license.
Screenshots:
Link to project screenshots.
Changelog:
Link to changelog.
CVS tree:
Link to webcvs/viewcvs.
Demo site:
Link to a live demo.
Issue information
Issue tracker:
Enable issue tracker
Let users submit bug requests, patches, feature requests, support  
requests, etc.
Default version:
Default version for issues.
Components:



>
> best
> Gunnar
>
>
>> * Requirements (other modules)
>> * Install requires
>>     [ ] folder upload
>>     [ ] database table insertion
>>            ( ) sql script alters existing tables
>>     [ ] other configuration ___________
>> * Permissions available
>> * Menu changes
>> * Blocks available
>> * Theming concerns
>> * Known conflicts
>> * Tarball last updated: _______________
>>
>> ....or something like that? If there were a standard set of headings,
>>  it might help make the modules documentation hold together.
>>
>> Laura
>>
>> --
>> Pending work: http://drupal.org/project/issues/documentation/
>> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> Gunnar Langemark
> gunnar at langemark.com
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>