Jump to content

Akademy/2013/DocumentationBoF: Difference between revisions

From KDE Community Wiki
Claus chr (talk | contribs)
No edit summary
Claus chr (talk | contribs)
No edit summary
Line 1: Line 1:
== Documentation BoF ==
== Documentation BoF ==
Some things we might discuss. Other topics are welcomed!


=== Creation of documentation on UserBase ===
=== Creation of documentation on UserBase ===

Revision as of 11:45, 14 July 2013

Documentation BoF

Some things we might discuss. Other topics are welcomed!

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.