[drupal-docs] Drupal Handbook Authoring Standards

[Dries Buytaert]

Bèr Kessels wrote:
>>I would like to create a set of coding and formating standards for the
>>Drupal Handbook.  I have created a first attempt here:
>>http://drupal.org/node/15289
> 
> Looks great. But can you extend this to all drupal documentation? The drupal 
> help texts in modules should follow these rules too IMO.

Looks good but:

1. That page should be part of the "Documentation writer's guide", not
part of the "About the handbook" section.

2. For consistency, the title should be "Drupal handbook authoring 
guidelines" (not "Drupal Handbook Authoring Guidelines") or "Authoring 
guidelines" for short.  Make that a guideline.

3. Shouldn't sections headers use <h2> first?  IIRC, the page title uses 
<h1>.

4. Use relative links where possible.

-- 
Dries Buytaert  ::  http://www.buytaert.net/