Wiki Documentation BoF SEE2009
From Symbian Developer Community
Contents |
Building knowledge through wiki documentation
This page records notes on the Birds of a Feather (BoF) session at SEE 2009 on 27th October 2009.
The BoF was devoted to discussing how the wiki should be used to present world class documentation for Symbian developers.
Slides
The slides can be downloaded from File:Wiki documentation SEE BoF Oct2009.pdf.
Notes
There were three main talking points, discussed in each of the following subsections. We spent most time on the first, and received some useful feedback about how the attendees preferred to interact with the reference documentation.
The unification of reference library and wiki content
The slides were presented to describe the current state of documentation and how it will evolve early next year, and how potentially it could change longer term.
The feedback I think was most interesting was that:
- attendees aren't necessarily that bothered about having a wiki front end to the reference documentation, but would like to have the ability to leave comments on individual pages
- the preference was for a single set of documentation that ran across versions, rather than individual sets of documents for each platform release
- developers said they'd prefer to have documentation on the entire platform, even if some APIs weren't 'public' and subject to the compatibility promise. We do at least make the product reference available to everyone now, so hope that goes some way to improving things already!
This was a really helpful discussion - if you'd like to add comment or further notes here please go ahead...
Using wiki - open discussion
We discussed how to moderate documentation and the importance of knowing who is working on the site.
Longer term projects
Marcus explained that, although he is someone with a first language other than English, he did not consider localised documentation to be that important. His view is that the translated page can date or diverge from the English version, which is likely to be the definitive version, so he'd prefer just to use that.
Attendees
These are the attendees I noted down. Please add your name if I've neglected to include you, and thank you for coming! If you have a web page or wiki user page that you'd like to include here, please feel free to add it.
- Louise Breinholt - John Wiley & Sons
- Jessica Rathke - Jonckers
- Dominic Pinkman - Nokia, Package Owner
- Michel Szarindar - Nokia, Package Owner
- Richard Bloor - Sherpa Consulting
- Pamela Toh - Vodafone Betavine
- Anthony Fabriccino - Nokia
- Marcus Groeber - Nuance Communications
- Ben Morris - Samsung
- Grant Jeffers - Nokia
- Charles Sparey - Sybase iAnywhere User:Lgw741
- Dennis Lee - Symbian
- Ivan Litovski - Symbian
- Hamish Willee - Symbian
- Magda Voigt - Symbian
- Tim Williams - Symbian
- Satu Dahl - Symbian
Sign in to comment…
