[drupal-docs] Workflow for the admin/help documentation application
sprint
Kieran Lal
kieran at civicspacelabs.org
Tue May 10 16:29:49 UTC 2005
Hi, I would like to explain the work flow I am proposing to support
the application sprint. I reviewed several discussions from the
Drupal docs archive regarding workflow and I will attempt to take
those suggestions under consideration.
The goal is to create or edit the admin/help pages in Drupal.
1. Decide the general organization of the content.
-We agreed on the handbook titles, conducted user interviews via
survey and conducted a usability experiment to see how users would
like the content organized.
-We created the handbooks, and pages where appropriate. See http://
drupal.org/handbook/v2
2. Establish serious, detailed, style guides
-http://drupal.org/handbook/about/authoring
3. Establish a workflow
Build consensus => research topics => create Wiki pages => recruit
volunteers => review documentation by docs team => submit patches
-We gained a consensus on having short admin/help descriptions with
links to the workbook and administration interfaces.
-We researched the topics providing links to admin interfaces,
documentation help, and packages of modules in CVS.
-We created wiki pages for authors to write admin/help for modules.
-We sent out a note requesting volunteers, and got responses.
-The wiki pages have begun to be reviewed by the docs team, thanks
Boris.
4.Review old documentation and rewrite, and reorganize based on new
guidelines.
-Ensure all new documentation should go through the docs team to
ensure quality.
-Patches need to be created and submitted to go against head.
Comments? Suggestions?
Kieran
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050510/10cef5fd/attachment.htm
More information about the drupal-docs
mailing list