[drupal-docs] Round 4 of documentation sprint Admin help: merging into the handbook

puregin puregin at puregin.org
Tue May 24 18:37:04 UTC 2005


     I'm a little concerned about making the Administrator's guide even
more confusing than it currently is.

     I'm thinking of the new admin help as being similar in spirit
to Unix 'man pages', and I'm imagining collecting them all
into something which would essentially be an appendix -
used for reference.

     I think that the existing content is sometimes of this format,
other times not.   I think that this existing content can be
coerced into more of a 'cookbook' format.

    Here's the current structure: I'm going to associate chapter
numbers, to make discussion easier:

    Administrator's guide
      1. Introduction
      2. Installation
      3. Configuration
      4. Blocks
      5. Drupal modules and features
      6. Upgrading from previous versions
      7. Migrating from other weblog software
      8. Backups
      9. Best practices
    10. Troubleshooting FAQ

      I think of the Troubleshooting FAQ, Upgrading, and Migrating
sections as appendices, because they would likely be
read by only a subset of readers, and each of these sections
stands alone.

      I'd like to see the Admin help become an appendix also.
Existing Admin help documentation could be put into a
'Versions prior to 4.6' section of this appendix.

      I propose an organization something like this:

    Administrator's guide
      1. Introduction
      2. Installation
      3. Configuration
      4. Day-to-day administration
           ...
           Backups (was 8.)
           ...
      5. Cookbook
           ...
           Best practices (was 9.)
           ...
    A1. Drupal modules quick-help
           Core
           Contrib
           Versions prior to 4.6
    A2. Upgrading from previous versions (was 6.)
    A3. Migrating from other weblog software (was 7.)
    A4. Troubleshooting FAQ (was 10.)













  
  




More information about the drupal-docs mailing list