Handbook style guide needs structural work [#406782]

During the 3/18/09 doc sprint, we discussed the current structure of the Handbook style guide. It's currently comprised of http://drupal.org/about/authoring, titled "Handbook style guide;" http://drupal.org/documentation-writers-guide, titled "Handbook structure;" and http://drupal.org/node/338208, titled "Handbook style." The aliases and titles themselves are confusing, and the content on the pages is likely to overlap or even conflict.

We (add1sun, laken, margaux, winston & myself) discussed the possibility of taking the content from the Handbook style and Handbook structure pages, merging it and cleaning up redundancies and conflicts, and then re-splitting again into different pages to avoid one massively long page and to make the Handbook style guide easier to navigate and read. We didn't come up with a plan for how to do this, so if folks think it's a good idea, we'll have to figure out how to best get it done.

Comments

Comment #1

leehunter commented 19 March 2009 at 14:51

+1 to this.

If we did this, some people (me for one) would find it useful to have an optional "Style Guide" block showing the main headings of the guide.

Comment #2

MGParisi commented 28 April 2009 at 06:06

+1 to this. This seems to be falling back into the land of never seen again Doc changes that should happen. So I guess this is a Bump too:)

Comment #3

figaro commented 8 April 2010 at 21:24

Version:

6.x-1.x-dev

The handbook structure guide could do with some images. Comments need to be integrated and then removed with the text on both the style guide and the structure guide. Texts in both guides could be made more concise. It will make it easier to integrate the two from then on.