Brainstorm 2010/Wiki

(New page: {{Brainstorm 2010}} == Wiki == What processes can be put in place to ensure high quality wiki content? What documentation is needed? How should it be organised?)
 
Line 3: Line 3:
What processes can be put in place to ensure high quality wiki content? What documentation is needed? How should it be organised?
What processes can be put in place to ensure high quality wiki content? What documentation is needed? How should it be organised?
 +
 +
* [https://bugs.maemo.org/show_bug.cgi?id=10092 Fix maemo.org search] (ChoMar)
 +
* Organise Maemo documentation better across versions (Jaffa)
 +
*: Example for Python docs:
 +
** Maemo 3 had Python documentation, but the canonical place for that now is the wiki ([s]http://pymaemo.garage.maemo.org/[s])
 +
** Maemo 4 had lots of PDF documentation so isn't easy to search
 +
** Maemo 5 has docs spread across the wiki (both current and archive), Forum Nokia tutorials and the Info Center.
 +
* Difficult to know whether wiki content is valid or not for a given OS. Need to make it clear which versions a Wiki page applies to (juise-)
 +
* Prepare Style guidelines - a set of rules for creating pages eg. a Q&A page should be different from an API page. But every Q&A page should look the same. (other styles: About (something, eg. history about N900), Tutorial, Summary page, Application description/use etc. (Robb)
 +
* Appoint Style maintainer (auditor) - someone(/or group) who maintains the styles and assess pages for readibility (Robb)
 +
** See [[Wiki gardeners]]
 +
* Category + summary pages - need to organize a bit, to reach useful pages. (Robb)
 +
** Suggestions welcome at [[wiki gardeners]]

Latest revision as of 16:30, 24 May 2010

Image:Ambox_notice.png
 This article is continued discussion from the Maemo brainstorm 2010
Please see the Brainstorm 2010 agenda for more.

[edit] Wiki

What processes can be put in place to ensure high quality wiki content? What documentation is needed? How should it be organised?

  • Fix maemo.org search (ChoMar)
  • Organise Maemo documentation better across versions (Jaffa)
    Example for Python docs:
    • Maemo 3 had Python documentation, but the canonical place for that now is the wiki ([s]http://pymaemo.garage.maemo.org/[s])
    • Maemo 4 had lots of PDF documentation so isn't easy to search
    • Maemo 5 has docs spread across the wiki (both current and archive), Forum Nokia tutorials and the Info Center.
  • Difficult to know whether wiki content is valid or not for a given OS. Need to make it clear which versions a Wiki page applies to (juise-)
  • Prepare Style guidelines - a set of rules for creating pages eg. a Q&A page should be different from an API page. But every Q&A page should look the same. (other styles: About (something, eg. history about N900), Tutorial, Summary page, Application description/use etc. (Robb)
  • Appoint Style maintainer (auditor) - someone(/or group) who maintains the styles and assess pages for readibility (Robb)
  • Category + summary pages - need to organize a bit, to reach useful pages. (Robb)
Retrieved from "http://bugs.maemo.org/Brainstorm_2010/Wiki"