[documentation] Handbook re-org

Kieran Lal kieran at civicspacelabs.org
Mon Sep 10 14:27:37 UTC 2007


It might be worth doing the Drupal documentation categorization exercise I
did a couple years ago.  We could get probably a thousand users to
categorize major  topics into buckets using a flash app.

My concern with these kinds of re-design efforts is they address the needs
of the power users and not the 10X larger new user base.

Cheers,
Kieran

On 9/4/07, Steven Peck <sepeck at gmail.com> wrote:
>
> Ok.  I went through several edits and misc other stuff but keep
> running into time crunches and distractions....
>
> So let's just toss out broad outlines.  The first book will no longer
> be the existing 'About Drupal'
> We'll start with the base, "Installation and configuration".  Yes
> there will be some cross over stuff here but we can deal with it.
>
> As it is designed to somewhat version specific with parts that are not
> we can sort of split it.
> * Getting Started *
> - Project and features
> - Before you start
> - Drupal 6
> +- Installation etc
> - Drupal 5
> + - Installation etc
> - Drupal 4.7
> + - This will contain many of the older pages that aren't getting
> unpublished.
> -Concepts
> - - Collected articles etc.
>
> BTW ( Addison's ideas were better then mine so here they are)
> * HowTos and Snippets*
> - HowTos
> + - The advanced user guide
> + - Site recipes
> + - Theme tutorials
> + - Contrib module HowTos
> - Snippets (partial solutions, bits and pieces)
> + - Introduction to the concept / use / risks
> + - PHP Snippets
> + - PHP Template Snippets
> + - Contributed modules
> - Videocasts
>
>
> * Theme developers guide *
> -Theming overview - introduce things.
> + - Engines overview engines with a lean towards phptemplate
> + I get fuzzy on the details after this part.  There aare differences
> between 4.7-5.0 and 6.0.  dvessel is actually writing theme docs for
> D6 right now separately so we have a start right there for some what
> versioned docs.  How to integrate them in a sane manner still needs
> some thought and response.
>
> * Developing for Drupal *
> Currently I am not planning on touching this yet.  I do have some
> ideas on it but just re-organizing two and integrating a third is
> enough initial scope.  There are two main areas in this book though.
> One is module development, the other is drupal.org project use and
> maintenance of projects/cvs/etc.  So it may be good to give it some
> thought for later.
>
> * Drupal Site Resources * or some such inclusive title.
> This pulls in the stuff that was in About Drupal.
> The About Drupal documentation goes in.
>
> I have more thoughts but am stopping here
>
> Steven Peck
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



-- 
To strive, to seek, to find, and not to yield.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20070910/69503c96/attachment.htm 


More information about the documentation mailing list