Stc tc open_documentation
-
Upload
janet-swisher -
Category
Documents
-
view
378 -
download
2
description
Transcript of Stc tc open_documentation
![Page 1: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/1.jpg)
Open Documentation
Eric Shepherd (@sheppy)Janet Swisher (@jmswisher)
Mozilla Developer Network
![Page 2: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/2.jpg)
Questions welcome!
• What are you looking for?• What problems are you facing?• What do you hope to learn?
![Page 3: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/3.jpg)
What we’re gonna tell ya
• Ideas and definitions– Community– Community-generated content– Openness– Open documentation
• Radically open docs on MDN• What you can do
![Page 4: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/4.jpg)
WHAT IS ... ?
![Page 5: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/5.jpg)
What is community?
“It is not merely the group that generates community, but the interactions within it.”―Jono Bacon, The Art of Community
![Page 6: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/6.jpg)
Types of community
Action
(shared goal)
Circumstance(e.g.,
cancer survivors)
Interest
(products, hobbies)
Place(e.g.,
neighbor-hoods)
Position
(e.g., teenager
s)
Practice
(shared expertise
& methods)
Purpose
(similar goals)
![Page 7: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/7.jpg)
What is community-generated content?
• Wiki-based docs• Wiki-based knowledge
article• Open source docs
(parallel to code)• Sample code
• Comments on web-based docs
• Comments on blogs• Support forums
![Page 8: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/8.jpg)
What CGC is NOT
Photo by Global X
![Page 9: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/9.jpg)
What CGC is NOT
Photo by blmurch
![Page 10: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/10.jpg)
Which comes first?
“The Apache Software Foundation … believes that its first order of business is creating healthy software content development communities focused on solving common problems; good software content is simply an emergent result.”―Brian Behlendorf, former president of the Apache Software Foundation
![Page 11: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/11.jpg)
Why be open?
![Page 12: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/12.jpg)
Why be open?
Goals• Participation• Agility• Momentum• Rapid prototyping• Leverage
What it is not• Public performance• Endless opinion-sharing• Magic “crowd-sourcing”
http://openmatt.wordpress.com/2011/04/06/how-to-work-open/
![Page 13: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/13.jpg)
What is open documentation?
For Mozilla Developer Network, it means:• Open to read (without login)• Open to modify (with login)• Open to copy and distribute (Creative
Commons: Attribution-ShareAlike)• Open to remix (CC-BY-SA, again)(See the The Free Software Definition by GNU)
![Page 14: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/14.jpg)
MOZILLA DEVELOPER NETWORK
![Page 15: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/15.jpg)
What is MDN?
Content• Web development:
reference, tutorials, and guides
• Mozilla products
• Mozilla APIs
• Mozilla project (building, testing, debugging, process)
• Firefox add-on development
Audience
• Web developers & Web app developers
• Developers using Mozilla code/libraries
• Developers working on the Mozilla project
• Add-on developers
![Page 16: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/16.jpg)
Where content comes from
• Some historical content (e.g., inherited from Netscape)
• New material
• Some paid for by Mozilla
• Some contributed by Mozilla community
• Some from other communities or organizations
![Page 17: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/17.jpg)
Documentation process
• Bugzilla as a documentation planning tool• Documentation-specific bugs• Tags on engineering bugs
• Prioritization and delegation• Tagging for review
![Page 18: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/18.jpg)
Engaging contributors
• Multiple communication channels
• Community meetings
• Doc sprints
• Express gratitude early and often
![Page 19: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/19.jpg)
Pitfalls
Image by @joefoodie
![Page 20: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/20.jpg)
Villains
Photo by istolethetv
![Page 21: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/21.jpg)
Why people don’t contribute
• They don’t realize it's a wiki
• They don’t want to bother setting up an account
• They’re intimidated by changing “the” documentation
![Page 22: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/22.jpg)
Avoiding pitfalls and villains
•Vigilant content review
•Good, easy-to-find guidelines and templates
•Patience
•Constant community engagement
![Page 23: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/23.jpg)
Signs of success
![Page 24: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/24.jpg)
IN YOUR WORLD
![Page 25: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/25.jpg)
Who is your community?
Tech PubsSales
Engineering
Consulting
Support
Partners
Customers
General Public
![Page 26: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/26.jpg)
Realistic expectations
Photo by JoshBerglund19
![Page 27: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/27.jpg)
Who will contribute?
90%: “lurk” but never contribute
9%: do a little 1%: do a lot
Jakob Nielsen, Participation Inequality: Encouraging More Users to Contribute
Image by verbeeldingskr8
![Page 28: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/28.jpg)
Why do people contribute?
“Why do people contribute free documentation? Results of a survey,” Andy Oram
![Page 29: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/29.jpg)
Challenges
• Access–Who can see, contribute, approve?
• Accuracy–How do you make sure it’s correct?
• Authority–How can readers trust it?
![Page 30: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/30.jpg)
Contribution Process
Patch Model• Submit > Review > Publish• Content is not public until it
is reviewed.
Wiki Model• Submit > Publish > Review• Content is public
immediately.• May want to visually
differentiate unreviewed content.
Or, allow comments but not direct edits at all.
![Page 31: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/31.jpg)
Paths to success
• Welcome Wagon• Tasks for newbies• Multiple communication channels• Recognition and reputation• Mentor and empower• Gratitude• Recognition and reputation
![Page 32: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/32.jpg)
Being “Gameful”
• Positive Emotion and engagement• Building positive Relationships• Meaning: connecting to a mission or goal
greater than ourselves• Accomplishment: opportunity to do
something that matters
![Page 33: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/33.jpg)
Take-aways
Photo by renaissancechambara
![Page 34: Stc tc open_documentation](https://reader034.fdocuments.in/reader034/viewer/2022051412/54b6010d4a7959e0058b458f/html5/thumbnails/34.jpg)
Resources
• The Art of Community: Building the New Age of Participation, Jono Bacon
• Conversation and Community: The Social Web for Documentation, Anne Gentle
• “Participation Inequality: Encouraging More Users to Contribute,” Jakob Nielsenhttp://www.useit.com/alertbox/participation_inequality.html
• “Why do people write free documentation? Results of a survey,” Andy Oramhttp://onlamp.com/onlamp/2007/06/14/why-do-people-write-free-documentation-results-of-a-survey.html
• Reality is Broken: Why Games Make Us Better and How They Can Change the World, Jane McGonigal