wiki.ipfire.org

The community-maintained documentation platform of IPFire

User Tools

Site Tools


projects:docs:workflow

Documentation Workflow

This is the workflow that is used for writing wiki sections.

|-week one-------------------------------------|-week two-------------------------------------|
|                                              |                                              |
|  |----------------------------------------|  |                                              |
|  |                                        |  |                                              |
|  | (E) Translation of pages from last     |<-|-----------------------                       |
|  |  sprint (translators)                  |  |                       `                      |
|  |                                        |  |                       |                      |
|  |----------------------------------------|  |                       |                      |
|                                              |                       |                      |
|                                              |                       |                      |
|----------------------------------------------|                       |                      |
|                                              |                       |                      |
|                                              |                       |                      |
|  |----------------------------------------|  |  |----------------------------------------|  |
|  |                                        |  |  |                                        |  |
|  | (A) Define topic to work on            |<-|--| (D) Browse through the wiki and forum  |  |
|  |  (coordinator)                         |  |  | * find things that need to be improved |  |
|  |                                        |  |  | * send suggestions to the coordinator  |  |
|  |----------------------------------------|  |  |                                        |  |
|                      |                       |  |----------------------------------------|  |
|                      |                       |                       ^                      |
|                      |                       |                      /|\                     |
|                     \|/                      |                       |                      |
|                      °                       |                       |                      |
|  |----------------------------------------|  |  |----------------------------------------|  |
|  |                                        |  |  |                                        |  |
|  | (B) Authoring the article in English   |--|->| (C) Review of the content              |  |
|  |  (all authors on the team)             |  |  |  (all authors on the team)             |  |
|  |                                        |  |  |                                        |  |
|  |----------------------------------------|  |  |----------------------------------------|  |
|                                              |                                              |
|----------------------------------------------|----------------------------------------------|

Roles

There are several roles in this workflow. Everyone can be part in one or more groups.

Authors

The group of authors is the group that writes the actual content (B). They either write it from scratch or rewrite/reword pages and add or remove information.

Translators

The translators do not create new content, but translate content from the primary languge (English) into their own languages. There will multiple translator teams - each for one language.

The coordinator

The coordinator is the person who controls the workflow and helps the other people sticking to it. He can also be part of the authors and translators teams.

Schedule

The schedule is a two week schedule which may be extended or shortened in some cases. The coordinator sets the dates of the schedule and controls that everyone is on the schedule.

Step A

At the beginning of each run (i.e. the first day), the coordinator defines a list of sections or pages. He picks that from suggestions that can be sent in by everybody and tries to prioritize them.

Step B

The authors work on writing the content. How bigger sections are split up and assigned to individual persons can be sorted out in the group. If that does not work, the coordinator has to help sorting this out.

This should not take more than a week.

Step C

The written content needs to be reviewed by other people on the team. Unclear paragraphs and other sorts of problems need to be fixed. The native speakers should check grammar and spelling.

Step D

Everyone browses the wiki and searches for things that need improvement.

Here is also time for the authors to fix minor problems and so on.

Step E

After the written content has been approved by the authors and the coordinator, the translators can start translating the pages into their own languages. Reviewing that is only part of the translation teams.

projects/docs/workflow.txt · Last modified: 2013/07/12 14:33 by MichaelTremer