Radically open documentation
•Télécharger en tant que PPT, PDF•
0 j'aime•1,146 vues
What's it like to not just allow community contributions to your documentation, but depend on them? What if literally anybody could edit the docs and see your work as you write? Mozilla doc team members share their experiences working with radically open documentation for developers. Presentation by Eric Shepherd and Janet Swisher at the Technical Communication Summit, May 2011
Recommandé
Recommandé
Contenu connexe
Tendances
Tendances (14)
Similaire à Radically open documentation
Similaire à Radically open documentation (20)
Dernier
Dernier (20)
Radically open documentation
- 1. Radically Open Documentation Eric Shepherd (@sheppy) Janet Swisher (@jmswisher) Mozilla Developer Network Session hashtag: #radopen
- 2. Why Be Open?
- 16. Signs of Success
Notes de l'éditeur
- The web is too big for one company to document. It encourages contributions from user and developers of other browsers.
- We (as employees) are peers with the rest of the community when it comes to creation and curation of content. Sheppy is “ documentation lead ” in that he tries to organize the content and project management side of things, and we are wiki admins because someone needs to be, but we are not the end-all of power on the site. Content Janet and Sheppy create goes through the same process, and carries the same weight, as anyone else ’ s.
- Other community content can be donated or paid for by other organizations, like Google or IBM.
- Note also that Bugzilla is open to everyone to read (with the exception of specific security bugs), and to edit with a login. Talk about Florian ’ s tool a bit.
- Need to offer examples of community contributors, including tools like trevor ’ s mdni and Florian ’ s doc tracker
- IRC, email, mailing list
- Accuracy: dated content, incorrect information, missing key details Editorial: Mis-filed or mis-titled articles, Poor formatting and layout, Bad grammar and spelling
- The well-intentioned but wrong can be the worst of these because they ’ re hard to detect, and could be converted into valuable contributors sometimes, but it ’ s hard to be sure.
- Tell the story of the guy who was hesitant to edit docs written by the guy that invented JavaScript.