[drupal-docs] SoC Documentation

Kieran Lal kieran at civicspacelabs.org
Thu Sep 1 01:30:39 UTC 2005


Please follow the module administration help guidelines for  
documentation.

Writing Guidelines here: http://drupal.org/node/24268
How to understand a module so you can document it here: http:// 
drupal.org/node/30048

When you have written two paragraphs, benefits of module and list of  
things the module can do, as well as a list of context sensitive  
links please post as a documentation issue on Drupal.org.  The  
documentation team will review you modules documentation and post it  
for you in the contributed modules section here: http://drupal.org/ 
handbook/config/contribmodules

Cheers,
Kieran
On Aug 31, 2005, at 3:36 AM, Robert Douglass wrote:

> Hello Summer of Code students and documentation list,
>
> All of the Summer of Code projects are coming to an end and we have  
> some really great contributions to be thankful for. The code is  
> excellent and  the level of participation from the 11 students has  
> been remarkable. But, as we all know, code is not everything. Thus  
> commences the autumn of documentation :-)
>
> SoC students (especially those whose native language is not  
> English), please do the following:
>
> 1) Make sure that you have included, at a minimum, README.txt and  
> INSTALL.txt with your projects. Please take some time to write the  
> highest quality documentation that you can. Look to great modules  
> like the banner module or img_assist for examples of how top  
> developers document their code.
> 2) Post your texts to this list and ask for assistance with the  
> phrasing and the quality of communication. Having others proofread  
> your work is important for any writer. You can also include  
> comments from inside your code for people to look at.
> 3) Work with the people on the documentation list and incorporate  
> the changes suggested into your documentation.
>
>
> Documentation list; please take the time to support our SoC  
> students, they've worked really hard so far!
>
> cheers,
>
> Robert
> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>
>




More information about the drupal-docs mailing list