L10n:Better Documentation

From MozillaWiki
Revision as of 13:20, 8 July 2009 by StasM (talk | contribs)
Jump to navigation Jump to search

Let's make the l10n documentation better by updating, cleaning and categorizing the content available on the wikis and blogs

Steps

  1. Create "Conditions of premises" of our documentation:
    1. chart all available resources on a single graph
    2. decide which documents need updating, which are obsolete and which are up-to-date
    3. indicate where each resource is currently located (wikimo, mdc, someone's blog, etc)
  2. Define our target audiences for documentation and their needs:
    1. developers - ?
    2. localizers - ?
    3. potential new contributors - ?
    4. l10n drivers - ?
    5. etc.
  3. Categorize:
    1. using the output from point 2, categorize existing documents into target-specific groups
    2. update existing documents with their target in mind
    3. identify missing documents and create them
    4. decide where each document should live (wikimo, mdc?)
    5. make use of wiki's categories, tags and hierarchies to organize content
  4. Create the home page
    1. provide useful starting points for all (or most of) target groups
  5. Create guidelines for maintaining and updating the documentation
    1. naming conventions
    2. should each document have an owner?
    3. what should we document, where and how?

Related resources