[drupal-docs] Handbook v2

Anisa mystavash at animecards.org
Sun Mar 20 03:30:55 UTC 2005


I added some details under each of Boris's root book headings, just 
looking at the original handbook.  I apologize if that was a little 
counter productive.  ^.^;

I also added a translator guide.  Not sure on the doc writer's guide.  
Not worthy of it's own book, perhaps.

I have thoughts on the user guide which are not important at this 
particular moment except to say I don't think it needs its own book.  Is 
there value to making working group books publically available to all 
and sundry?

The important thing as far as making the book is the special stuff.

I don't know how permissions work right now, so perhaps a description of 
that would bring to light deficiencies and benefits in the current system.

Perhaps it's helpful to think of it in terms of workflow.  I do think 
it's important that new documentation bits go through the documentation 
team so that they can ensure the quality of the documentation.  Forum 
threads certainly should not go straight to the handbook. 

I wonder if (very theoretical, no clue how this all works) it might be 
helpful to have it like a bug/issue list.  People can submist an issue 
they have with the documentation, and the docs ml will get a weekly 
summary of all the open issues.  In the case of forums, perhaps they can 
be moved to the documenation working group (details on working groups 
here http://drupal.org/node/18270) book where they can be condensed.

Anisa.
6.4 earthquakes are scary!


Boris Mann wrote:

> OK, after I made enough of stink, we got to  a consensus, sort of. 
> Comments are another issue which we can't solve right away, but which 
> we can police a lot more effectively as we build up new pages.
>
> I've written up extensive thoughts here: 
> http://dev.bryght.com/t/wiki/HandbookVersionTwo
>
> It includes book technology suggestions. Please add/edit comments there.
>
> On 18-Mar-05, at 12:11 PM, Dries Buytaert wrote:
>
>> OK, it appears there are a number of issues here.  To summarize:
>>
>> 1. The documentation sucks: people don't find the information they need.
>> 2. The process to maintain documentation sucks: documentation writers 
>> don't know what is going on.
>> 3. Poor separation between user and developer community.
>>
>> We want to tackle (1) by reorganizing the handbook from scratch.  We 
>> need to tackle (2) by improving Drupal itself, and the book module in 
>> particular (or by using CVS). There are different ways we can tackle 
>> (3).
>
>
> I actually don't see (3) as too much of an issue. Or rather, that we 
> can serve both communities by my suggested hierarchies, and perhaps 
> some guidance on the front page of Drupal that points different user 
> groups to appropriate channels/an intro page.
>
>>> Here's an alternative that MIGHT work: give us a new root book -- 
>>> call it handbook v2. The doc team can decide how best to organize 
>>> this, and migrate external and local pages into it. It's still 
>>> starting from scratch, but it retains node IDs.
>>
>>
>> That works for me.  We'd still need to deal with 2 and 3 separately 
>> though.
>
>
> -- 
> Boris Mann
> http://www.bryght.com
>



More information about the drupal-docs mailing list