[drupal-docs] Styleguide

[Anisa]

matome

Please continue adding more and commenting on current suggestions!  
These are the ones up so far.

Formatting

    * Don't use H1, H4, H5, or H6.
    * Do not repeat the title in the page.  (dunno if this is a problem,
      but just in case)
    * Capitalize only the first letter in the title, except for proper
      nouns.  Ex. Installing modules; About Drupal.
    * If this is a copy of documentation distributed some other way (ex.
      install.txt) please cite your source. (pet peeve ^.^)
    * Organization: This page should only be 3 clicks away from the root
      page. 
    * Use <?php tags for php code snippets.

Text content

    * Do not use 1st person pronouns: I, my, we, our, etc.
    * Redundancy: Make sure that nothing is repeated elsewhere in the
      handbook.  No need to re-invent the wheel.
    * Include references to relevant or related pages as much as possible.
    * Keep to the topic in the document.  If you are writing on topic C,
      and C requires knowing about A and B, make seperate pages for A and B.

Linking

    * Internal (to user's drupal installation): always include the
      actual drupal path. (ex. not just path > to > item > destination,
      but also admin/node/configure)
    * Internal (to drupal.org): Always use the drupal path, and add a
      description to the link.  Ex. <a href="node/1234567"
      title="information">
    * Examples: Example URLs should use 'www.example.com' as the domain
      name.


Anisa.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050425/8daf95f9/attachment.htm