SlideShare uma empresa Scribd logo
1 de 37
Baixar para ler offline
BECKY TODD | SR. DEV EXPERIENCE WRITER | ATLASSIAN | @BECKATODD
Engineering Content
Champions
Technical writer?
Technical editor?
IDENTITY CRISIS
Editing involves creative
skills, human relations, and a
precise set of methods.
Wikipedia
High value
Solves specific problems,
highlights gaps
Hidden
Not discoverable, unscalable,
limits self-help
Content in the wild
Curate content,
even though their
main role is not
technical writing
CONTENT CHAMPIONS
CONTENT CHAMPIONS
• Support engineers
• Developers
• Product managers
• Product designers
• Community members
Crowdsourcing
Community of equal peers
working toward a common
outcome… with no one
participant benefiting more
than any other.
Leverages the marginal
interest of a group of people
to complete a task that
otherwise could not be
economically completed.
CROWDSOURCING OPEN SOURCING
http://www.computerworlduk.com/it-business/crowdsource-is-not-open-source-3569582/
Crowdsourcing content
A content development approach that
relies on occasional authors volunteering
content
Unlocks knowledge
Leverages insight from experts in different roles,
both inside and outside the organization
Minimizes bottlenecks
More authors means fewer roadblocks to
publishing quickly
Solves specific issues
Addresses edge cases or specific use cases not
typically documented
Advantages of
crowdsourcing
Unlocks knowledge
Leverages insight from experts in different roles,
both inside and outside the organization
Minimizes bottlenecks
More authors means fewer roadblocks to
publishing quickly
Solves specific issues
Addresses edge cases or specific use cases not
typically documented
Advantages of
crowdsourcing
Unlocks knowledge
Leverages insight from experts in different roles,
both inside and outside the organization
Minimizes bottlenecks
More authors means fewer roadblocks to
publishing quickly
Solves specific issues
Addresses edge cases or specific use cases not
typically documented
Advantages of
crowdsourcing
Distributes responsibility
Ownership becomes less clear and can lead to
confusion about roles
Poorly written
Content is more difficult to understand, poorly
formatted, etc.
Quantity is not quality
Too much content can actually be detrimental to
the user experience
Challenges of
crowdsourcing
Distributes responsibility
Ownership becomes less clear and can lead to
confusion about roles
Poorly written
Content is more difficult to understand, poorly
formatted, etc.
Quantity is not quality
Too much content can actually be detrimental to
the user experience
Challenges of
crowdsourcing
Distributes responsibility
Ownership becomes less clear and can lead to
confusion about roles
Poorly written
Content is more difficult to understand, poorly
formatted, etc.
Quantity is not quality
Too much content can actually be detrimental to
the user experience
Challenges of
crowdsourcing
90% of the people on any community
project remain quiet lurkers; 9%
contribute moderately, and 1%
contribute actively.
Tom Johnson, I’d Rather Be Writing
Lay a foundation
CONTENT MANAGEMENT
• Communicate clear goals and outcomes
• Create well-defined and simple processes
• Get buy in from teams, stakeholders
• Ensure editorial oversight happens
Writing toolkit
Instructions
How to setup and publish
content, step-by-step
Style guides
Brand, voice, and usage
guidelines
Best practices
When to write, writing
checklists, templates
contribute mergeapprove publish
authorreviewerapprover
DEV
TW
PO
Simple workflow
Content management
Training
In-person training sessions
and self-help resources
Planning
Content strategy sessions,
release and feature planning
Feedback
Comment-based review and
copy editing
Putting it all together
Reinforce the
role of content in
the process
DOCS-FIRST CULTURE
“Good documentation
shows respect.
DANIELE PROCIDA, CONTENT MANAGER, DJANGO
Brief case study
Support engineers built a KB from
scratch and launched it in a little
under a quarter.
CROWDSOURCED KNOWLEDGE BASE
High number of support
cases and no shared
knowledge
PROBLEM
Build knowledge base and
integrate it with product help
SOLUTION
Plan
Defined requirements, information architecture,
templates, and content processes
Train
Developed team-specific training materials
adapted from the writing toolkit
Build
Crowdsourced the content creation
1
2
3
Continued growth
300 + articles published. The team has good and bad quarters but continues to have
a steady flow of up-to-date articles.
Workflow and tooling updates
The team identified additional use cases and has migrated content to a new tool
that better supports their workflow.
Cross-departmental collaboration
The knowledge base maintenance process has led to a need for strong cross-
department collaboration between Engineering and Support.
15 MONTHS LATER: SUCCESSES AND CHALLENGES
Empower your
champions, and
reward their
successes
IN CLOSING
Questions
Thank you!
BECKY TODD | SR. DEV EXPERIENCE WRITER | ATLASSIAN | @BECKATODD
• "Documentation Guide." Write the Docs (2017) http://www.writethedocs.org/guide/
• Editing definition, Wikipedia. https://en.wikipedia.org/wiki/Editing
• Johnson, Tom. “Crowdsourcing docs with docs-as-code tools--same result as with wikis?” I’d Rather Be
Writing (8 March2017). http://idratherbewriting.com/2017/03/08/crowdsourcing-docs-with-github-docs-
as-code-tools-same-as-wikis/
• Phipps, Simon. “Crowdsource Is Not Open Source.” Computerworld UK. (30 November 2010). http://
www.computerworlduk.com/it-business/crowdsource-is-not-open-source-3569582/
• Procida, Daniele. Documentation-driven development–lessons learned from the Django Project. (PyCon
2016) https://www.youtube.com/watch?v=bQSR1UpUdFQ&feature=youtu.be
• Software license definitions, Wikipedia. https://en.wikipedia.org/wiki/Software_license
REFERENCES
• Django documentation (2017) https://docs.djangoproject.com/en/1.10/internals/contributing/writing-
documentation/
• Rackspace Developer Docs (2017) https://developer.rackspace.com/docs/private-cloud/rpc/v14/rpc-
swift/
EXAMPLES

Mais conteúdo relacionado

Mais procurados

Strategic Thinking in a Global and Digital World
Strategic Thinking in a Global and Digital WorldStrategic Thinking in a Global and Digital World
Strategic Thinking in a Global and Digital WorldRobin Teigland
 
Effective Communication With Virtual Teams
Effective Communication With Virtual TeamsEffective Communication With Virtual Teams
Effective Communication With Virtual Teamsalyanliker
 
[LDP] Virtual Leadership (11 03 10)
[LDP] Virtual Leadership (11 03 10)[LDP] Virtual Leadership (11 03 10)
[LDP] Virtual Leadership (11 03 10)AIESEC in Spain
 
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...Rosenfeld Media
 
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...Blend Interactive
 
Planning for Content Governance
Planning for Content GovernancePlanning for Content Governance
Planning for Content GovernanceRick Allen
 
Lunch & Learn Tool Kit
Lunch & Learn Tool KitLunch & Learn Tool Kit
Lunch & Learn Tool KitDanielle S
 
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...Blend Interactive
 
Fedrigoni smart working
Fedrigoni smart workingFedrigoni smart working
Fedrigoni smart workingFedrigoni SpA
 
Training: The Missing Element of Content Governance
Training: The Missing Element of Content GovernanceTraining: The Missing Element of Content Governance
Training: The Missing Element of Content GovernanceRick Allen
 
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018Josh Silverman
 
Working Out Loud - Introduction
Working Out Loud - IntroductionWorking Out Loud - Introduction
Working Out Loud - IntroductionR__Ganesh
 
Time to do things differently event 1
Time to do things differently event 1Time to do things differently event 1
Time to do things differently event 1Iriss
 
Building Success in a Connected World: ThinkBiz2011
Building Success in a Connected World: ThinkBiz2011Building Success in a Connected World: ThinkBiz2011
Building Success in a Connected World: ThinkBiz2011Ross Dawson
 
Curation Fundamentals: How & Why to Get Started with Curation
Curation Fundamentals: How & Why to Get Started with CurationCuration Fundamentals: How & Why to Get Started with Curation
Curation Fundamentals: How & Why to Get Started with CurationMike Taylor
 

Mais procurados (19)

Getting Global
Getting GlobalGetting Global
Getting Global
 
Strategic Thinking in a Global and Digital World
Strategic Thinking in a Global and Digital WorldStrategic Thinking in a Global and Digital World
Strategic Thinking in a Global and Digital World
 
Effective Communication With Virtual Teams
Effective Communication With Virtual TeamsEffective Communication With Virtual Teams
Effective Communication With Virtual Teams
 
[LDP] Virtual Leadership (11 03 10)
[LDP] Virtual Leadership (11 03 10)[LDP] Virtual Leadership (11 03 10)
[LDP] Virtual Leadership (11 03 10)
 
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...
Distributed Design Operations Management (Jilanna Wilson at DesignOps Summit ...
 
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...
“The Five Meetings You Meet in Web Design” by Kevin Hoffman (Now What? Confer...
 
Planning for Content Governance
Planning for Content GovernancePlanning for Content Governance
Planning for Content Governance
 
Lunch & Learn Tool Kit
Lunch & Learn Tool KitLunch & Learn Tool Kit
Lunch & Learn Tool Kit
 
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...
Next Level Collaboration: The Future of Content and Design by Rebekah Cancino...
 
Fedrigoni smart working
Fedrigoni smart workingFedrigoni smart working
Fedrigoni smart working
 
Training: The Missing Element of Content Governance
Training: The Missing Element of Content GovernanceTraining: The Missing Element of Content Governance
Training: The Missing Element of Content Governance
 
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018
Then, Now, Next: Evolution of the Design Business – Bucharest Tech Week 2018
 
Working Out Loud - Introduction
Working Out Loud - IntroductionWorking Out Loud - Introduction
Working Out Loud - Introduction
 
Time to do things differently event 1
Time to do things differently event 1Time to do things differently event 1
Time to do things differently event 1
 
P745 As
P745 AsP745 As
P745 As
 
Virtual Team Management
Virtual Team ManagementVirtual Team Management
Virtual Team Management
 
Building Success in a Connected World: ThinkBiz2011
Building Success in a Connected World: ThinkBiz2011Building Success in a Connected World: ThinkBiz2011
Building Success in a Connected World: ThinkBiz2011
 
Curation Fundamentals: How & Why to Get Started with Curation
Curation Fundamentals: How & Why to Get Started with CurationCuration Fundamentals: How & Why to Get Started with Curation
Curation Fundamentals: How & Why to Get Started with Curation
 
Lunch and Learn Initiative
Lunch and Learn InitiativeLunch and Learn Initiative
Lunch and Learn Initiative
 

Semelhante a Engineering content-champions-todd-stc-2017

Stronger together: how to build your cross-team content engine
Stronger together:  how to build your cross-team content engineStronger together:  how to build your cross-team content engine
Stronger together: how to build your cross-team content enginePerry Hewitt
 
Avoid a redesign train wreck: Get your content from point A to B
Avoid a redesign train wreck: Get your content from point A to BAvoid a redesign train wreck: Get your content from point A to B
Avoid a redesign train wreck: Get your content from point A to BLynn Winter
 
Collaboration from the Trenches : Building your Internal Communities with Mic...
Collaboration from the Trenches : Building your Internal Communities with Mic...Collaboration from the Trenches : Building your Internal Communities with Mic...
Collaboration from the Trenches : Building your Internal Communities with Mic...D'arce Hess
 
Curated not Created
Curated not Created Curated not Created
Curated not Created David Blake
 
Taking the next step: Building Organisational Co-design Capability
Taking the next step: Building Organisational Co-design CapabilityTaking the next step: Building Organisational Co-design Capability
Taking the next step: Building Organisational Co-design CapabilityPenny Hagen
 
weConnect - the Enterprise
weConnect - the EnterpriseweConnect - the Enterprise
weConnect - the Enterprisehugoleijtens
 
How To Build Vibrant Communities Within The Enterprise
How To Build Vibrant Communities Within The EnterpriseHow To Build Vibrant Communities Within The Enterprise
How To Build Vibrant Communities Within The EnterpriseDavid Terrar
 
Social Meida For Project Success - PMI Australia Conference 2013 Presentation
Social Meida For Project Success - PMI Australia Conference 2013 PresentationSocial Meida For Project Success - PMI Australia Conference 2013 Presentation
Social Meida For Project Success - PMI Australia Conference 2013 PresentationAnfernee Chansamooth
 
Approaching Developer Relations in an Open Source community
Approaching Developer Relations in an Open Source communityApproaching Developer Relations in an Open Source community
Approaching Developer Relations in an Open Source communityAll Things Open
 
Gathering Insights part of Designing Experiences in #Office365 #mwcp19
Gathering Insights part of Designing Experiences in #Office365 #mwcp19Gathering Insights part of Designing Experiences in #Office365 #mwcp19
Gathering Insights part of Designing Experiences in #Office365 #mwcp19Kanwal Khipple
 
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)Four Kitchens
 
Diversity, Inclusive Mindsets, and Architecture
Diversity, Inclusive Mindsets, and ArchitectureDiversity, Inclusive Mindsets, and Architecture
Diversity, Inclusive Mindsets, and ArchitectureTracy Lee
 
Content strategy for the content experience wave
Content strategy for the content experience waveContent strategy for the content experience wave
Content strategy for the content experience waveZoran Nikolovski
 
Collective 2016-workshop-2016-06-05-final
Collective 2016-workshop-2016-06-05-finalCollective 2016-workshop-2016-06-05-final
Collective 2016-workshop-2016-06-05-finalContent Strategy Inc.
 
Adopt & Adapt: A Faster Path to Experience Governance & Standards
Adopt & Adapt: A Faster Path to Experience Governance & StandardsAdopt & Adapt: A Faster Path to Experience Governance & Standards
Adopt & Adapt: A Faster Path to Experience Governance & StandardsSusan Price
 
Managing your online profile
Managing your online profileManaging your online profile
Managing your online profileSue Beckingham
 
How to Measure & Build Social Influence
How to Measure & Build Social InfluenceHow to Measure & Build Social Influence
How to Measure & Build Social InfluenceDerek Laney
 
Handout for new blended learning
Handout for new blended learningHandout for new blended learning
Handout for new blended learningTaleo Research
 
Design Operations
Design OperationsDesign Operations
Design OperationsDave Malouf
 

Semelhante a Engineering content-champions-todd-stc-2017 (20)

Stronger together: how to build your cross-team content engine
Stronger together:  how to build your cross-team content engineStronger together:  how to build your cross-team content engine
Stronger together: how to build your cross-team content engine
 
Avoid a redesign train wreck: Get your content from point A to B
Avoid a redesign train wreck: Get your content from point A to BAvoid a redesign train wreck: Get your content from point A to B
Avoid a redesign train wreck: Get your content from point A to B
 
Collaboration from the Trenches : Building your Internal Communities with Mic...
Collaboration from the Trenches : Building your Internal Communities with Mic...Collaboration from the Trenches : Building your Internal Communities with Mic...
Collaboration from the Trenches : Building your Internal Communities with Mic...
 
Curated not Created
Curated not Created Curated not Created
Curated not Created
 
Taking the next step: Building Organisational Co-design Capability
Taking the next step: Building Organisational Co-design CapabilityTaking the next step: Building Organisational Co-design Capability
Taking the next step: Building Organisational Co-design Capability
 
weConnect - the Enterprise
weConnect - the EnterpriseweConnect - the Enterprise
weConnect - the Enterprise
 
How To Build Vibrant Communities Within The Enterprise
How To Build Vibrant Communities Within The EnterpriseHow To Build Vibrant Communities Within The Enterprise
How To Build Vibrant Communities Within The Enterprise
 
Social Meida For Project Success - PMI Australia Conference 2013 Presentation
Social Meida For Project Success - PMI Australia Conference 2013 PresentationSocial Meida For Project Success - PMI Australia Conference 2013 Presentation
Social Meida For Project Success - PMI Australia Conference 2013 Presentation
 
Why social?
Why social?Why social?
Why social?
 
Approaching Developer Relations in an Open Source community
Approaching Developer Relations in an Open Source communityApproaching Developer Relations in an Open Source community
Approaching Developer Relations in an Open Source community
 
Gathering Insights part of Designing Experiences in #Office365 #mwcp19
Gathering Insights part of Designing Experiences in #Office365 #mwcp19Gathering Insights part of Designing Experiences in #Office365 #mwcp19
Gathering Insights part of Designing Experiences in #Office365 #mwcp19
 
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)
Don't Design Websites. Design Web SYSTEMS! (BADCamp 2011)
 
Diversity, Inclusive Mindsets, and Architecture
Diversity, Inclusive Mindsets, and ArchitectureDiversity, Inclusive Mindsets, and Architecture
Diversity, Inclusive Mindsets, and Architecture
 
Content strategy for the content experience wave
Content strategy for the content experience waveContent strategy for the content experience wave
Content strategy for the content experience wave
 
Collective 2016-workshop-2016-06-05-final
Collective 2016-workshop-2016-06-05-finalCollective 2016-workshop-2016-06-05-final
Collective 2016-workshop-2016-06-05-final
 
Adopt & Adapt: A Faster Path to Experience Governance & Standards
Adopt & Adapt: A Faster Path to Experience Governance & StandardsAdopt & Adapt: A Faster Path to Experience Governance & Standards
Adopt & Adapt: A Faster Path to Experience Governance & Standards
 
Managing your online profile
Managing your online profileManaging your online profile
Managing your online profile
 
How to Measure & Build Social Influence
How to Measure & Build Social InfluenceHow to Measure & Build Social Influence
How to Measure & Build Social Influence
 
Handout for new blended learning
Handout for new blended learningHandout for new blended learning
Handout for new blended learning
 
Design Operations
Design OperationsDesign Operations
Design Operations
 

Último

VTU technical seminar 8Th Sem on Scikit-learn
VTU technical seminar 8Th Sem on Scikit-learnVTU technical seminar 8Th Sem on Scikit-learn
VTU technical seminar 8Th Sem on Scikit-learnAmarnathKambale
 
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...masabamasaba
 
WSO2CON 2024 Slides - Open Source to SaaS
WSO2CON 2024 Slides - Open Source to SaaSWSO2CON 2024 Slides - Open Source to SaaS
WSO2CON 2024 Slides - Open Source to SaaSWSO2
 
%in tembisa+277-882-255-28 abortion pills for sale in tembisa
%in tembisa+277-882-255-28 abortion pills for sale in tembisa%in tembisa+277-882-255-28 abortion pills for sale in tembisa
%in tembisa+277-882-255-28 abortion pills for sale in tembisamasabamasaba
 
%in Benoni+277-882-255-28 abortion pills for sale in Benoni
%in Benoni+277-882-255-28 abortion pills for sale in Benoni%in Benoni+277-882-255-28 abortion pills for sale in Benoni
%in Benoni+277-882-255-28 abortion pills for sale in Benonimasabamasaba
 
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...WSO2
 
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open Source
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open SourceWSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open Source
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open SourceWSO2
 
What Goes Wrong with Language Definitions and How to Improve the Situation
What Goes Wrong with Language Definitions and How to Improve the SituationWhat Goes Wrong with Language Definitions and How to Improve the Situation
What Goes Wrong with Language Definitions and How to Improve the SituationJuha-Pekka Tolvanen
 
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyviewmasabamasaba
 
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...masabamasaba
 
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...WSO2
 
WSO2CON 2024 - How to Run a Security Program
WSO2CON 2024 - How to Run a Security ProgramWSO2CON 2024 - How to Run a Security Program
WSO2CON 2024 - How to Run a Security ProgramWSO2
 
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital TransformationWSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital TransformationWSO2
 
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024VictoriaMetrics
 
Architecture decision records - How not to get lost in the past
Architecture decision records - How not to get lost in the pastArchitecture decision records - How not to get lost in the past
Architecture decision records - How not to get lost in the pastPapp Krisztián
 
tonesoftg
tonesoftgtonesoftg
tonesoftglanshi9
 
WSO2CON 2024 - Does Open Source Still Matter?
WSO2CON 2024 - Does Open Source Still Matter?WSO2CON 2024 - Does Open Source Still Matter?
WSO2CON 2024 - Does Open Source Still Matter?WSO2
 
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...masabamasaba
 

Último (20)

VTU technical seminar 8Th Sem on Scikit-learn
VTU technical seminar 8Th Sem on Scikit-learnVTU technical seminar 8Th Sem on Scikit-learn
VTU technical seminar 8Th Sem on Scikit-learn
 
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...
%+27788225528 love spells in Knoxville Psychic Readings, Attraction spells,Br...
 
WSO2CON 2024 Slides - Open Source to SaaS
WSO2CON 2024 Slides - Open Source to SaaSWSO2CON 2024 Slides - Open Source to SaaS
WSO2CON 2024 Slides - Open Source to SaaS
 
%in tembisa+277-882-255-28 abortion pills for sale in tembisa
%in tembisa+277-882-255-28 abortion pills for sale in tembisa%in tembisa+277-882-255-28 abortion pills for sale in tembisa
%in tembisa+277-882-255-28 abortion pills for sale in tembisa
 
%in Benoni+277-882-255-28 abortion pills for sale in Benoni
%in Benoni+277-882-255-28 abortion pills for sale in Benoni%in Benoni+277-882-255-28 abortion pills for sale in Benoni
%in Benoni+277-882-255-28 abortion pills for sale in Benoni
 
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...
WSO2CON 2024 - Cloud Native Middleware: Domain-Driven Design, Cell-Based Arch...
 
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open Source
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open SourceWSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open Source
WSO2CON 2024 - Freedom First—Unleashing Developer Potential with Open Source
 
What Goes Wrong with Language Definitions and How to Improve the Situation
What Goes Wrong with Language Definitions and How to Improve the SituationWhat Goes Wrong with Language Definitions and How to Improve the Situation
What Goes Wrong with Language Definitions and How to Improve the Situation
 
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview
%in Hazyview+277-882-255-28 abortion pills for sale in Hazyview
 
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...
%+27788225528 love spells in Toronto Psychic Readings, Attraction spells,Brin...
 
Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in T...
Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in T...Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in T...
Abortion Pill Prices Tembisa [(+27832195400*)] 🏥 Women's Abortion Clinic in T...
 
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...
WSO2CON 2024 - API Management Usage at La Poste and Its Impact on Business an...
 
WSO2CON 2024 - How to Run a Security Program
WSO2CON 2024 - How to Run a Security ProgramWSO2CON 2024 - How to Run a Security Program
WSO2CON 2024 - How to Run a Security Program
 
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital TransformationWSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation
WSO2Con2024 - WSO2's IAM Vision: Identity-Led Digital Transformation
 
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024
Large-scale Logging Made Easy: Meetup at Deutsche Bank 2024
 
Architecture decision records - How not to get lost in the past
Architecture decision records - How not to get lost in the pastArchitecture decision records - How not to get lost in the past
Architecture decision records - How not to get lost in the past
 
tonesoftg
tonesoftgtonesoftg
tonesoftg
 
WSO2CON 2024 - Does Open Source Still Matter?
WSO2CON 2024 - Does Open Source Still Matter?WSO2CON 2024 - Does Open Source Still Matter?
WSO2CON 2024 - Does Open Source Still Matter?
 
Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pre...
Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pre...Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pre...
Abortion Pills In Pretoria ](+27832195400*)[ 🏥 Women's Abortion Clinic In Pre...
 
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...
%+27788225528 love spells in Colorado Springs Psychic Readings, Attraction sp...
 

Engineering content-champions-todd-stc-2017

  • 1. BECKY TODD | SR. DEV EXPERIENCE WRITER | ATLASSIAN | @BECKATODD Engineering Content Champions
  • 3. Editing involves creative skills, human relations, and a precise set of methods. Wikipedia
  • 4. High value Solves specific problems, highlights gaps Hidden Not discoverable, unscalable, limits self-help Content in the wild
  • 5. Curate content, even though their main role is not technical writing CONTENT CHAMPIONS
  • 6. CONTENT CHAMPIONS • Support engineers • Developers • Product managers • Product designers • Community members
  • 8. Community of equal peers working toward a common outcome… with no one participant benefiting more than any other. Leverages the marginal interest of a group of people to complete a task that otherwise could not be economically completed. CROWDSOURCING OPEN SOURCING http://www.computerworlduk.com/it-business/crowdsource-is-not-open-source-3569582/
  • 9. Crowdsourcing content A content development approach that relies on occasional authors volunteering content
  • 10. Unlocks knowledge Leverages insight from experts in different roles, both inside and outside the organization Minimizes bottlenecks More authors means fewer roadblocks to publishing quickly Solves specific issues Addresses edge cases or specific use cases not typically documented Advantages of crowdsourcing
  • 11. Unlocks knowledge Leverages insight from experts in different roles, both inside and outside the organization Minimizes bottlenecks More authors means fewer roadblocks to publishing quickly Solves specific issues Addresses edge cases or specific use cases not typically documented Advantages of crowdsourcing
  • 12. Unlocks knowledge Leverages insight from experts in different roles, both inside and outside the organization Minimizes bottlenecks More authors means fewer roadblocks to publishing quickly Solves specific issues Addresses edge cases or specific use cases not typically documented Advantages of crowdsourcing
  • 13. Distributes responsibility Ownership becomes less clear and can lead to confusion about roles Poorly written Content is more difficult to understand, poorly formatted, etc. Quantity is not quality Too much content can actually be detrimental to the user experience Challenges of crowdsourcing
  • 14. Distributes responsibility Ownership becomes less clear and can lead to confusion about roles Poorly written Content is more difficult to understand, poorly formatted, etc. Quantity is not quality Too much content can actually be detrimental to the user experience Challenges of crowdsourcing
  • 15. Distributes responsibility Ownership becomes less clear and can lead to confusion about roles Poorly written Content is more difficult to understand, poorly formatted, etc. Quantity is not quality Too much content can actually be detrimental to the user experience Challenges of crowdsourcing
  • 16. 90% of the people on any community project remain quiet lurkers; 9% contribute moderately, and 1% contribute actively. Tom Johnson, I’d Rather Be Writing
  • 17.
  • 19. CONTENT MANAGEMENT • Communicate clear goals and outcomes • Create well-defined and simple processes • Get buy in from teams, stakeholders • Ensure editorial oversight happens
  • 20. Writing toolkit Instructions How to setup and publish content, step-by-step Style guides Brand, voice, and usage guidelines Best practices When to write, writing checklists, templates
  • 22. Content management Training In-person training sessions and self-help resources Planning Content strategy sessions, release and feature planning Feedback Comment-based review and copy editing
  • 23. Putting it all together
  • 24. Reinforce the role of content in the process DOCS-FIRST CULTURE
  • 25. “Good documentation shows respect. DANIELE PROCIDA, CONTENT MANAGER, DJANGO
  • 26.
  • 28. Support engineers built a KB from scratch and launched it in a little under a quarter. CROWDSOURCED KNOWLEDGE BASE
  • 29. High number of support cases and no shared knowledge PROBLEM
  • 30. Build knowledge base and integrate it with product help SOLUTION
  • 31. Plan Defined requirements, information architecture, templates, and content processes Train Developed team-specific training materials adapted from the writing toolkit Build Crowdsourced the content creation
  • 32. 1 2 3 Continued growth 300 + articles published. The team has good and bad quarters but continues to have a steady flow of up-to-date articles. Workflow and tooling updates The team identified additional use cases and has migrated content to a new tool that better supports their workflow. Cross-departmental collaboration The knowledge base maintenance process has led to a need for strong cross- department collaboration between Engineering and Support. 15 MONTHS LATER: SUCCESSES AND CHALLENGES
  • 33. Empower your champions, and reward their successes IN CLOSING
  • 35. Thank you! BECKY TODD | SR. DEV EXPERIENCE WRITER | ATLASSIAN | @BECKATODD
  • 36. • "Documentation Guide." Write the Docs (2017) http://www.writethedocs.org/guide/ • Editing definition, Wikipedia. https://en.wikipedia.org/wiki/Editing • Johnson, Tom. “Crowdsourcing docs with docs-as-code tools--same result as with wikis?” I’d Rather Be Writing (8 March2017). http://idratherbewriting.com/2017/03/08/crowdsourcing-docs-with-github-docs- as-code-tools-same-as-wikis/ • Phipps, Simon. “Crowdsource Is Not Open Source.” Computerworld UK. (30 November 2010). http:// www.computerworlduk.com/it-business/crowdsource-is-not-open-source-3569582/ • Procida, Daniele. Documentation-driven development–lessons learned from the Django Project. (PyCon 2016) https://www.youtube.com/watch?v=bQSR1UpUdFQ&feature=youtu.be • Software license definitions, Wikipedia. https://en.wikipedia.org/wiki/Software_license REFERENCES
  • 37. • Django documentation (2017) https://docs.djangoproject.com/en/1.10/internals/contributing/writing- documentation/ • Rackspace Developer Docs (2017) https://developer.rackspace.com/docs/private-cloud/rpc/v14/rpc- swift/ EXAMPLES