[drupal-docs] building handbook 2

[Anisa]

A status check before I go on my busy vacation.  (by this time next 
week, I'll probably have visited 5 different cities... ^.^)

1. Decide the general organization of content. 
http://dev.bryght.com/t/wiki/HandbookVersionTwo
We are looking at the following root books.
About Drupal
Getting Started
Admin Guide
End User Guide
Developer Guide
About the Handbook

(that's quite a few!  Sure we can't roll the handbook book some other 
way?  And hey, if we're going to have many books, why not change Guide 
to Handbook?  Ie, Admin Handbook?  Am I clever or what? ;) )

2. Establish serious, detailed, style guides, as Djun Kim suggested.  
http://drupal.org/node/15289
Mostly done.  Also, I drop opposition to the evil headers thing.  So 
long as the quality of text is improved.

3. Establish a work flow.  For example, wiki > handbook > print format.
It seems the most feasible is to:

    * Create the root books (with html editor), with a block that says
      they are under development.
    * Give doc team permissions to edit handbook and deal with queue.
    * Edit pages on Drupal.org itself.  Use node revisions to keep track
      of edits.

However, since we are rewriting the whole thing, it may also be feasible 
to at least work, in the beginning, in a wiki, any kind will do.  So the 
workflow would look like this:

    * Create the root books (with html editor), with a block that says
      they are under development.
    * Give doc team permissions to edit handbook and deal with queue.
    * Develop handbooks in a wiki.
    * Copy wiki pages into handbook, clean up style, structure.  Add
      relevant links.
    * When the new handbook can replace the old, switch 'em, and from
      then on edit on Drupal.org itself.

People may want to argue with the above, but then please come up with an 
alternative that works more smoothly in your opinion. 

4. Review old documentation and rewrite, and reorganize based on new 
guidelines.
Once 1-3 are set, the rest should be fine.

5. Voila, beauty.

I am not going to be around too too much for the next week as I go 
around western Japan, not that I have such an ego that I think this will 
matter ;). 

Anisa.


Anisa wrote:

> I haven't decided if it's a good thing or a bad thing, but the more I 
> get involved in this Drupal thing, the more often I find myself 
> sounding like Steven.  I'm leaning towards a bad thing.  ;p
>
> I view the process of building handbook 2 in this manner:
> 1. Decide the general organization of content. 
> http://dev.bryght.com/t/wiki/HandbookVersionTwo
> 2. Establish serious, detailed, style guides, as Djun Kim suggested.  
> http://drupal.org/node/15289
> 3. Establish a work flow.  For example, wiki > handbook > print format.
> 4. Review old documentation and rewrite, and reorganize based on new 
> guidelines.
> 5. Voila, beauty.
>
> It'd be one thing if there were lots of people here, but there aren't, 
> so I do believe that doing things out of this order can be counter 
> productive. 
>
> Feel free to disagree.  ^.^  But work on that wiki page while you're 
> at it.
>
> Anisa.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050428/facde8b1/attachment.htm