Akademy/2013/DocumentationBoF: Difference between revisions
Created page with "== Documentation BoF == === Creation of documentation on UserBase === Pros: * Everyone can contribute * Collaborative process * Many eyes (editrors, translators) - spots pro..." |
No edit summary |
||
| Line 6: | Line 6: | ||
* Everyone can contribute | * Everyone can contribute | ||
* Collaborative process | * Collaborative process | ||
* Many eyes (editrors, translators) - | * Many eyes (editrors, translators) - spot problems | ||
* Nice interface for translation | * Nice interface for translation | ||
Cons? | Cons? | ||
* Dockbooc formatting doesn't completely match with UserBase formatting | * Dockbooc formatting doesn't completely match with UserBase formatting | ||
Tools: | |||
* automated Wiki -> DocBook program in Python (still requires some manual intervention) | |||
* automated DocBook -> Wiki program TBA? | |||
* Better support for interface strings, versionsnumbers ...? | |||
* Better integration with existing tools: Lokalize, pology. | |||
=== Building teams of documenters === | |||
Documentation is a task, that "regular users" can contribute to. May be a good gateway into the community. | |||
Revision as of 10:59, 14 July 2013
Documentation BoF
Creation of documentation on UserBase
Pros:
- Everyone can contribute
- Collaborative process
- Many eyes (editrors, translators) - spot problems
- Nice interface for translation
Cons?
- Dockbooc formatting doesn't completely match with UserBase formatting
Tools:
- automated Wiki -> DocBook program in Python (still requires some manual intervention)
- automated DocBook -> Wiki program TBA?
- Better support for interface strings, versionsnumbers ...?
- Better integration with existing tools: Lokalize, pology.
Building teams of documenters
Documentation is a task, that "regular users" can contribute to. May be a good gateway into the community.