SlideShare a Scribd company logo
Write The Docs, Prague, 2015 1
Gardening Open Docs
Florian Scholz &
Jean-Yves Perrier
Write The Docs, Prague, 2015 2
Write The Docs, Prague, 2015 3
An heterogenous
corpus
Open Web
Beginner content
English
Expert-made
Experimental tech.
Mozilla products
Expert content
41 other languages
Learner-made
Mature technologies
Write The Docs, Prague, 2015 4
Different types of gardens
French Gardens
The triumph of Geometry
Used by traditional media.
The dictatorship of the plan:
‒ Defined before the building start.
‒ Strictly followed.
https://www.flickr.com/photos/odlagz/5265367815/
Write The Docs, Prague, 2015 5
Different types of gardens
British Gardens
“Since gardens (…) work with
material that grows and decays,
keeping them in good shape is a
design issue.”
Lodewijk Baljon,
famous Dutch landscaper
Wiki provides:
‒ Flexibility
‒ Parallelism
‒ Reuse / remixhttps://www.flickr.com/photos/simonov/14601290250/
Write The Docs, Prague, 2015 6
Gardener challenges
You don’t start with a ready-to-farm field, but with a jungle.
https://www.flickr.com/photos/vissago/2903489440/ https://www.flickr.com/photos/cewe/4561467390/
Write The Docs, Prague, 2015 7
Gardener challenges
Bad weeds
‒ Orthographic, grammatical,
and typographic errors
‒ Misplaced edits
‒ Small factual errors
Appears more often on wasteland
On-boarding new contributors
Transplant valuable edits
Review edits https://www.flickr.com/photos/rhruzek/4420490349/
Write The Docs, Prague, 2015 8
Gardener challenges
Diseases
Illegal and inappropriate content like:
‒ copyright violations,
‒ pornography,
‒ … (worse).
Like for fire blight, the authorities
can burn your garden.
Invasive plants
‒ Spam
‒ Misshaped refactorization
Make the garden plants suffocate and
kill them.
https://www.flickr.com/photos/ngawangchodron/14820021418 https://www.flickr.com/photos/dharmasphere/16598562313
Write The Docs, Prague, 2015 9
Planning the garden
Which species to choose?
https://www.flickr.com/photos/martinlabar/2417636285/ https://www.flickr.com/photos/martinlabar/7928914808/ https://www.flickr.com/photos/jim-sf/4439964275/
Write The Docs, Prague, 2015 10
Planning the garden
Automatic monitoring Prioritization
Product management input
Write The Docs, Prague, 2015 11
Building pathways
Navigation is a hard problem
Several entrances
Multiple goals
Bridges
Ladder to knowledge
No dead-end
Maps
Full accessibility
https://www.flickr.com/photos/werms/7076134605/
Write The Docs, Prague, 2015 12
Invite people on their way
Write The Docs, Prague, 2015 13
Gardening tools
https://www.flickr.com/photos/pleuntje/5809787537/
The community is
diverse and
cultivates the
garden in many
ways.
Help is needed in
which garden to use
which tool and how.
Write The Docs, Prague, 2015 14
MDN “meta” docs
I like code. I like words.
I like both. I like MDN in my language.
Write The Docs, Prague, 2015 15
Jungle vs Garden
Jungle
No trails / navigation
Doc trees not accessible
No inventory
Experts won’t get lost
here.
Garden
Garden is cultivated
Needs water
New seasons require work
Usually easier for
beginners to get started.
Write The Docs, Prague, 2015 16
Observe your garden
Know who is doing
what in your
gardens.
Which areas are
about to become a
wild jungle again?
https://www.flickr.com/photos/minhocos/13950908853/
Write The Docs, Prague, 2015 17
arewedocumentedyet.com
Which gardens need help and in what way?
Write The Docs, Prague, 2015 18
Doc status criterias
❏ Pages with no tags
❏ Pages with Needs* tags
❏ Editorial reviews needed
❏ Technical reviews needed
❏ Outdated pages
❏ Missing pages
❏ Documentation bugs filed
❏ ...
Write The Docs, Prague, 2015 19
Tool: Before leaving...
Write The Docs, Prague, 2015 20
Smell the flowers,
read the docs,
listen to the birds,
and… relax!
Thank you!
@floscholz, fscholz@mozilla.com @teoli2003, jperrier@mozilla.com
https://www.flickr.com/photos/raffywolfe/8692403782/

More Related Content

Similar to Gardening open docs - Write the Docs - Prague 2015

Web 2.0 presentation 26 4-12
Web 2.0 presentation 26 4-12Web 2.0 presentation 26 4-12
Web 2.0 presentation 26 4-12Geogphil
 
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE
 
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
Pedro Príncipe
 
British Library Labs Roadshow Scotland 2016
British Library Labs Roadshow Scotland 2016British Library Labs Roadshow Scotland 2016
British Library Labs Roadshow Scotland 2016
labsbl
 
Making connections - open practices in technology-mediated ELT
Making connections - open practices in technology-mediated ELTMaking connections - open practices in technology-mediated ELT
Making connections - open practices in technology-mediated ELT
Shona Whyte
 
The drawbridge to knowledge - Linking scholarly publications and research inf...
The drawbridge to knowledge - Linking scholarly publications and research inf...The drawbridge to knowledge - Linking scholarly publications and research inf...
The drawbridge to knowledge - Linking scholarly publications and research inf...
Lukas Koster
 
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
OpenAIRE
 
Flip the Library
Flip the LibraryFlip the Library
Flip the Library
Shayne Russell
 
Social media as a tool in research
Social media as a tool in researchSocial media as a tool in research
Social media as a tool in research
Sociostrategy
 
Developing a Publication Strategy
Developing a Publication StrategyDeveloping a Publication Strategy
Developing a Publication StrategyFrances Bell
 
Reference Management Course 2015: Complete Materials
Reference Management Course 2015: Complete MaterialsReference Management Course 2015: Complete Materials
Reference Management Course 2015: Complete Materials
Dasapta Erwin Irawan
 
Hands-on Workshop at the ESERA-Conference 2015
Hands-on Workshop at the ESERA-Conference 2015Hands-on Workshop at the ESERA-Conference 2015
Hands-on Workshop at the ESERA-Conference 2015
Go-Lab Initiative
 
Webinar ple 20_6_12
Webinar ple 20_6_12Webinar ple 20_6_12
Webinar ple 20_6_12
Denis Gillet
 
Workshop August 17, 2011 Elementary
Workshop August 17, 2011 ElementaryWorkshop August 17, 2011 Elementary
Workshop August 17, 2011 Elementarysmacnicoll
 
Discovery at the RLUK conference 2012
Discovery at the RLUK conference 2012Discovery at the RLUK conference 2012
Discovery at the RLUK conference 2012
andymcg
 
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
Brussels, Belgium
 
Linked Data for Abbreviations and Segmentation
Linked Data for Abbreviations and SegmentationLinked Data for Abbreviations and Segmentation
Linked Data for Abbreviations and SegmentationSebastian Hellmann
 
Meet the Flat Classroom 2012
Meet the Flat Classroom 2012Meet the Flat Classroom 2012
Meet the Flat Classroom 2012
Flat Classrooms
 
BL Labs Presentation at Språkbanken, University of Gothenberg
BL Labs Presentation at  Språkbanken, University of GothenbergBL Labs Presentation at  Språkbanken, University of Gothenberg
BL Labs Presentation at Språkbanken, University of Gothenberg
labsbl
 
7 Steps to Flatten Your Classroom
7 Steps to Flatten Your Classroom7 Steps to Flatten Your Classroom
7 Steps to Flatten Your Classroom
Vicki Davis
 

Similar to Gardening open docs - Write the Docs - Prague 2015 (20)

Web 2.0 presentation 26 4-12
Web 2.0 presentation 26 4-12Web 2.0 presentation 26 4-12
Web 2.0 presentation 26 4-12
 
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
 
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
OpenAIRE services and tools for researchers/authors and projects (FOSTER work...
 
British Library Labs Roadshow Scotland 2016
British Library Labs Roadshow Scotland 2016British Library Labs Roadshow Scotland 2016
British Library Labs Roadshow Scotland 2016
 
Making connections - open practices in technology-mediated ELT
Making connections - open practices in technology-mediated ELTMaking connections - open practices in technology-mediated ELT
Making connections - open practices in technology-mediated ELT
 
The drawbridge to knowledge - Linking scholarly publications and research inf...
The drawbridge to knowledge - Linking scholarly publications and research inf...The drawbridge to knowledge - Linking scholarly publications and research inf...
The drawbridge to knowledge - Linking scholarly publications and research inf...
 
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
OpenAIRE services and tools, Pedro Príncipe (OpenAIRE workshop, Ghent, Nov.20...
 
Flip the Library
Flip the LibraryFlip the Library
Flip the Library
 
Social media as a tool in research
Social media as a tool in researchSocial media as a tool in research
Social media as a tool in research
 
Developing a Publication Strategy
Developing a Publication StrategyDeveloping a Publication Strategy
Developing a Publication Strategy
 
Reference Management Course 2015: Complete Materials
Reference Management Course 2015: Complete MaterialsReference Management Course 2015: Complete Materials
Reference Management Course 2015: Complete Materials
 
Hands-on Workshop at the ESERA-Conference 2015
Hands-on Workshop at the ESERA-Conference 2015Hands-on Workshop at the ESERA-Conference 2015
Hands-on Workshop at the ESERA-Conference 2015
 
Webinar ple 20_6_12
Webinar ple 20_6_12Webinar ple 20_6_12
Webinar ple 20_6_12
 
Workshop August 17, 2011 Elementary
Workshop August 17, 2011 ElementaryWorkshop August 17, 2011 Elementary
Workshop August 17, 2011 Elementary
 
Discovery at the RLUK conference 2012
Discovery at the RLUK conference 2012Discovery at the RLUK conference 2012
Discovery at the RLUK conference 2012
 
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
Scientix: ECSITE 2015 Annual Conference - Trento, Italy, 13 June 2015
 
Linked Data for Abbreviations and Segmentation
Linked Data for Abbreviations and SegmentationLinked Data for Abbreviations and Segmentation
Linked Data for Abbreviations and Segmentation
 
Meet the Flat Classroom 2012
Meet the Flat Classroom 2012Meet the Flat Classroom 2012
Meet the Flat Classroom 2012
 
BL Labs Presentation at Språkbanken, University of Gothenberg
BL Labs Presentation at  Språkbanken, University of GothenbergBL Labs Presentation at  Språkbanken, University of Gothenberg
BL Labs Presentation at Språkbanken, University of Gothenberg
 
7 Steps to Flatten Your Classroom
7 Steps to Flatten Your Classroom7 Steps to Flatten Your Classroom
7 Steps to Flatten Your Classroom
 

Recently uploaded

AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
Product School
 
The Future of Platform Engineering
The Future of Platform EngineeringThe Future of Platform Engineering
The Future of Platform Engineering
Jemma Hussein Allen
 
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
Tobias Schneck
 
Accelerate your Kubernetes clusters with Varnish Caching
Accelerate your Kubernetes clusters with Varnish CachingAccelerate your Kubernetes clusters with Varnish Caching
Accelerate your Kubernetes clusters with Varnish Caching
Thijs Feryn
 
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
UiPathCommunity
 
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
Albert Hoitingh
 
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdfFIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
FIDO Alliance
 
Transcript: Selling digital books in 2024: Insights from industry leaders - T...
Transcript: Selling digital books in 2024: Insights from industry leaders - T...Transcript: Selling digital books in 2024: Insights from industry leaders - T...
Transcript: Selling digital books in 2024: Insights from industry leaders - T...
BookNet Canada
 
Neuro-symbolic is not enough, we need neuro-*semantic*
Neuro-symbolic is not enough, we need neuro-*semantic*Neuro-symbolic is not enough, we need neuro-*semantic*
Neuro-symbolic is not enough, we need neuro-*semantic*
Frank van Harmelen
 
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
James Anderson
 
To Graph or Not to Graph Knowledge Graph Architectures and LLMs
To Graph or Not to Graph Knowledge Graph Architectures and LLMsTo Graph or Not to Graph Knowledge Graph Architectures and LLMs
To Graph or Not to Graph Knowledge Graph Architectures and LLMs
Paul Groth
 
UiPath Test Automation using UiPath Test Suite series, part 4
UiPath Test Automation using UiPath Test Suite series, part 4UiPath Test Automation using UiPath Test Suite series, part 4
UiPath Test Automation using UiPath Test Suite series, part 4
DianaGray10
 
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered QualitySoftware Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
Inflectra
 
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
Ramesh Iyer
 
Generating a custom Ruby SDK for your web service or Rails API using Smithy
Generating a custom Ruby SDK for your web service or Rails API using SmithyGenerating a custom Ruby SDK for your web service or Rails API using Smithy
Generating a custom Ruby SDK for your web service or Rails API using Smithy
g2nightmarescribd
 
State of ICS and IoT Cyber Threat Landscape Report 2024 preview
State of ICS and IoT Cyber Threat Landscape Report 2024 previewState of ICS and IoT Cyber Threat Landscape Report 2024 preview
State of ICS and IoT Cyber Threat Landscape Report 2024 preview
Prayukth K V
 
UiPath Test Automation using UiPath Test Suite series, part 3
UiPath Test Automation using UiPath Test Suite series, part 3UiPath Test Automation using UiPath Test Suite series, part 3
UiPath Test Automation using UiPath Test Suite series, part 3
DianaGray10
 
Leading Change strategies and insights for effective change management pdf 1.pdf
Leading Change strategies and insights for effective change management pdf 1.pdfLeading Change strategies and insights for effective change management pdf 1.pdf
Leading Change strategies and insights for effective change management pdf 1.pdf
OnBoard
 
Knowledge engineering: from people to machines and back
Knowledge engineering: from people to machines and backKnowledge engineering: from people to machines and back
Knowledge engineering: from people to machines and back
Elena Simperl
 
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
Product School
 

Recently uploaded (20)

AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...
 
The Future of Platform Engineering
The Future of Platform EngineeringThe Future of Platform Engineering
The Future of Platform Engineering
 
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024
 
Accelerate your Kubernetes clusters with Varnish Caching
Accelerate your Kubernetes clusters with Varnish CachingAccelerate your Kubernetes clusters with Varnish Caching
Accelerate your Kubernetes clusters with Varnish Caching
 
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...
 
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
Encryption in Microsoft 365 - ExpertsLive Netherlands 2024
 
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdfFIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
FIDO Alliance Osaka Seminar: Passkeys at Amazon.pdf
 
Transcript: Selling digital books in 2024: Insights from industry leaders - T...
Transcript: Selling digital books in 2024: Insights from industry leaders - T...Transcript: Selling digital books in 2024: Insights from industry leaders - T...
Transcript: Selling digital books in 2024: Insights from industry leaders - T...
 
Neuro-symbolic is not enough, we need neuro-*semantic*
Neuro-symbolic is not enough, we need neuro-*semantic*Neuro-symbolic is not enough, we need neuro-*semantic*
Neuro-symbolic is not enough, we need neuro-*semantic*
 
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using Deplo...
 
To Graph or Not to Graph Knowledge Graph Architectures and LLMs
To Graph or Not to Graph Knowledge Graph Architectures and LLMsTo Graph or Not to Graph Knowledge Graph Architectures and LLMs
To Graph or Not to Graph Knowledge Graph Architectures and LLMs
 
UiPath Test Automation using UiPath Test Suite series, part 4
UiPath Test Automation using UiPath Test Suite series, part 4UiPath Test Automation using UiPath Test Suite series, part 4
UiPath Test Automation using UiPath Test Suite series, part 4
 
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered QualitySoftware Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality
 
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
Builder.ai Founder Sachin Dev Duggal's Strategic Approach to Create an Innova...
 
Generating a custom Ruby SDK for your web service or Rails API using Smithy
Generating a custom Ruby SDK for your web service or Rails API using SmithyGenerating a custom Ruby SDK for your web service or Rails API using Smithy
Generating a custom Ruby SDK for your web service or Rails API using Smithy
 
State of ICS and IoT Cyber Threat Landscape Report 2024 preview
State of ICS and IoT Cyber Threat Landscape Report 2024 previewState of ICS and IoT Cyber Threat Landscape Report 2024 preview
State of ICS and IoT Cyber Threat Landscape Report 2024 preview
 
UiPath Test Automation using UiPath Test Suite series, part 3
UiPath Test Automation using UiPath Test Suite series, part 3UiPath Test Automation using UiPath Test Suite series, part 3
UiPath Test Automation using UiPath Test Suite series, part 3
 
Leading Change strategies and insights for effective change management pdf 1.pdf
Leading Change strategies and insights for effective change management pdf 1.pdfLeading Change strategies and insights for effective change management pdf 1.pdf
Leading Change strategies and insights for effective change management pdf 1.pdf
 
Knowledge engineering: from people to machines and back
Knowledge engineering: from people to machines and backKnowledge engineering: from people to machines and back
Knowledge engineering: from people to machines and back
 
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...
 

Gardening open docs - Write the Docs - Prague 2015

  • 1. Write The Docs, Prague, 2015 1 Gardening Open Docs Florian Scholz & Jean-Yves Perrier
  • 2. Write The Docs, Prague, 2015 2
  • 3. Write The Docs, Prague, 2015 3 An heterogenous corpus Open Web Beginner content English Expert-made Experimental tech. Mozilla products Expert content 41 other languages Learner-made Mature technologies
  • 4. Write The Docs, Prague, 2015 4 Different types of gardens French Gardens The triumph of Geometry Used by traditional media. The dictatorship of the plan: ‒ Defined before the building start. ‒ Strictly followed. https://www.flickr.com/photos/odlagz/5265367815/
  • 5. Write The Docs, Prague, 2015 5 Different types of gardens British Gardens “Since gardens (…) work with material that grows and decays, keeping them in good shape is a design issue.” Lodewijk Baljon, famous Dutch landscaper Wiki provides: ‒ Flexibility ‒ Parallelism ‒ Reuse / remixhttps://www.flickr.com/photos/simonov/14601290250/
  • 6. Write The Docs, Prague, 2015 6 Gardener challenges You don’t start with a ready-to-farm field, but with a jungle. https://www.flickr.com/photos/vissago/2903489440/ https://www.flickr.com/photos/cewe/4561467390/
  • 7. Write The Docs, Prague, 2015 7 Gardener challenges Bad weeds ‒ Orthographic, grammatical, and typographic errors ‒ Misplaced edits ‒ Small factual errors Appears more often on wasteland On-boarding new contributors Transplant valuable edits Review edits https://www.flickr.com/photos/rhruzek/4420490349/
  • 8. Write The Docs, Prague, 2015 8 Gardener challenges Diseases Illegal and inappropriate content like: ‒ copyright violations, ‒ pornography, ‒ … (worse). Like for fire blight, the authorities can burn your garden. Invasive plants ‒ Spam ‒ Misshaped refactorization Make the garden plants suffocate and kill them. https://www.flickr.com/photos/ngawangchodron/14820021418 https://www.flickr.com/photos/dharmasphere/16598562313
  • 9. Write The Docs, Prague, 2015 9 Planning the garden Which species to choose? https://www.flickr.com/photos/martinlabar/2417636285/ https://www.flickr.com/photos/martinlabar/7928914808/ https://www.flickr.com/photos/jim-sf/4439964275/
  • 10. Write The Docs, Prague, 2015 10 Planning the garden Automatic monitoring Prioritization Product management input
  • 11. Write The Docs, Prague, 2015 11 Building pathways Navigation is a hard problem Several entrances Multiple goals Bridges Ladder to knowledge No dead-end Maps Full accessibility https://www.flickr.com/photos/werms/7076134605/
  • 12. Write The Docs, Prague, 2015 12 Invite people on their way
  • 13. Write The Docs, Prague, 2015 13 Gardening tools https://www.flickr.com/photos/pleuntje/5809787537/ The community is diverse and cultivates the garden in many ways. Help is needed in which garden to use which tool and how.
  • 14. Write The Docs, Prague, 2015 14 MDN “meta” docs I like code. I like words. I like both. I like MDN in my language.
  • 15. Write The Docs, Prague, 2015 15 Jungle vs Garden Jungle No trails / navigation Doc trees not accessible No inventory Experts won’t get lost here. Garden Garden is cultivated Needs water New seasons require work Usually easier for beginners to get started.
  • 16. Write The Docs, Prague, 2015 16 Observe your garden Know who is doing what in your gardens. Which areas are about to become a wild jungle again? https://www.flickr.com/photos/minhocos/13950908853/
  • 17. Write The Docs, Prague, 2015 17 arewedocumentedyet.com Which gardens need help and in what way?
  • 18. Write The Docs, Prague, 2015 18 Doc status criterias ❏ Pages with no tags ❏ Pages with Needs* tags ❏ Editorial reviews needed ❏ Technical reviews needed ❏ Outdated pages ❏ Missing pages ❏ Documentation bugs filed ❏ ...
  • 19. Write The Docs, Prague, 2015 19 Tool: Before leaving...
  • 20. Write The Docs, Prague, 2015 20 Smell the flowers, read the docs, listen to the birds, and… relax! Thank you! @floscholz, fscholz@mozilla.com @teoli2003, jperrier@mozilla.com https://www.flickr.com/photos/raffywolfe/8692403782/