canmove, Confirmed users
1,448
edits
L10n:Better Documentation: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Let's make the l10n documentation better | Let's make the l10n documentation better by updating, cleaning and categorizing the content available on the wikis and blogs | ||
=Steps= | =Steps= | ||
# Create | # 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 | ||
## | ## identify missing documents (create stubs) | ||
## 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 | ||