L10n:Better Documentation: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 3: Line 3:
=Steps=
=Steps=


# Create "Conditions of premises" of our documentation:
# Create the complete inventory of our documentation:<br>''draft: Monday, July 13, final: Monday, August 3''
## chart all available resources on a single graph
## chart all available resources on a single graph
## decide which documents need updating, which are obsolete and which are up-to-date
## decide which documents need updating, which are obsolete and which are up-to-date
## indicate where each resource is currently located (wikimo, mdc, someone's blog, etc)
## indicate where each resource is currently located (wikimo, mdc, someone's blog, etc)
# Define our target audiences for documentation and their needs:
# Define our target audiences for documentation and their needs:<br>''August 3-7, Berlin''
## developers - ?
## developers - ?
## localizers - ?
## localizers - ?
Line 13: Line 13:
## l10n drivers - ?
## l10n drivers - ?
## etc.
## etc.
# Categorize:
# Categorize:<br>''August 3-7, Berlin''
## using the output from point 2, categorize existing documents into target-specific groups
## using the output from point 2, categorize existing documents into target-specific groups
## update existing documents with their target in mind
## identify missing documents (create stubs)
## identify missing documents and create them
## review existing documents with their target in mind
## decide where each document should live (wikimo, mdc?)
## decide where each document should live (wikimo, mdc?)
## move existing documents to the platform they belong to (wikimo, mdc, ...)
## make use of wiki's categories, tags and hierarchies to organize content
## make use of wiki's categories, tags and hierarchies to organize content
# Update/create content
## create missing documents as identified in step 3
## update existing documents as decided in step 3
# Create the home page
# Create the home page
## provide useful starting points for all (or most of) target groups
## provide useful starting points for all (or most of) target groups

Latest revision as of 13:45, 13 July 2009

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

Steps

  1. Create the complete inventory of our documentation:
    draft: Monday, July 13, final: Monday, August 3
    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:
    August 3-7, Berlin
    1. developers - ?
    2. localizers - ?
    3. potential new contributors - ?
    4. l10n drivers - ?
    5. etc.
  3. Categorize:
    August 3-7, Berlin
    1. using the output from point 2, categorize existing documents into target-specific groups
    2. identify missing documents (create stubs)
    3. review existing documents with their target in mind
    4. decide where each document should live (wikimo, mdc?)
    5. move existing documents to the platform they belong to (wikimo, mdc, ...)
    6. make use of wiki's categories, tags and hierarchies to organize content
  4. Update/create content
    1. create missing documents as identified in step 3
    2. update existing documents as decided in step 3
  5. Create the home page
    1. provide useful starting points for all (or most of) target groups
  6. 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

Retrieved from "https://wiki.allizom.org/index.php?title=L10n:Better_Documentation&oldid=154654"