Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Documentation as Empathy
Search
ericholscher
October 03, 2015
Technology
1
250
Documentation as Empathy
Presentation from Open Source & Feelings.
ericholscher
October 03, 2015
Tweet
Share
More Decks by ericholscher
See All by ericholscher
Introduction to Django Channels - ConFoo Vancouver 2016
ericholscher
0
230
Understanding Documentation Systems - ConFoo Vancouver 2016
ericholscher
0
290
Python Documentation: Past, Present, & Future
ericholscher
3
340
Understanding Documentation Systems
ericholscher
1
280
Introduction to Sphinx & Read the Docs Djangocon 2015
ericholscher
0
170
Announcing Read the Docs for Business
ericholscher
1
230
Write the Docs NA 2014 Introduction
ericholscher
0
160
Introduction to Sphinx & Read the Docs
ericholscher
3
500
Documentation Journey
ericholscher
1
120
Other Decks in Technology
See All in Technology
公開初日に Gemini CLI を試した話や FFmpeg と組み合わせてみた話など / Gemini CLI 初学者勉強会(#AI道場)
you
PRO
0
990
AIエージェントが書くのなら直接CloudFormationを書かせればいいじゃないですか何故AWS CDKを使う必要があるのさ
watany
17
6.9k
ビジネス職が分析も担う事業部制組織でのデータ活用の仕組みづくり / Enabling Data Analytics in Business-Led Divisional Organizations
zaimy
1
310
QuickSight SPICE の効果的な運用戦略~S3 + Athena 構成での実践ノウハウ~/quicksight-spice-s3-athena-best-practices
emiki
0
260
united airlines ™®️ USA Contact Numbers: Complete 2025 Support Guide
flyunitedhelp
1
470
ClaudeCodeにキレない技術
gtnao
0
430
AIの全社活用を推進するための安全なレールを敷いた話
shoheimitani
2
640
助けて! XからWaylandに移行しないと新しいGNOMEが使えなくなっちゃう 2025-07-12
nobutomurata
2
140
マルチプロダクト環境におけるSREの役割 / SRE NEXT 2025 lunch session
sugamasao
1
330
推し書籍📚 / Books and a QA Engineer
ak1210
0
120
american aa airlines®️ USA Contact Numbers: Complete 2025 Support Guide
aaguide
0
500
オフィスビルを監視しよう:フィジカル×デジタルにまたがるSLI/SLO設計と運用の難しさ / Monitoring Office Buildings: The Challenge of Physical-Digital SLI/SLO Design & Operation
bitkey
1
340
Featured
See All Featured
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
29
9.6k
Intergalactic Javascript Robots from Outer Space
tanoku
271
27k
Scaling GitHub
holman
460
140k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
357
30k
Rebuilding a faster, lazier Slack
samanthasiow
83
9.1k
Designing Experiences People Love
moore
142
24k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
50
5.5k
Speed Design
sergeychernyshev
32
1k
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
656
60k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
10
970
YesSQL, Process and Tooling at Scale
rocio
173
14k
Transcript
Open Source & Feelings Seattle October 3, 2015 Documentation as
Empathy Eric Holscher (@ericholscher)
7 years ago
I was writing Perl for the Military
No • Documentation • Version Control • Tests
It all started with a PDF
Serendipity • Feb 20: http://ericholscher.com/blog/ 2008/feb/20/job-hunt/ • Feb 21: https://jacobian.org/writing/
sailing-on/
Documentation Culture
People don’t use projects that don’t have docs
I start writing docs • Django Kong • Django Test
Utils • Django Reusable App Docs
Jacob was a huge influence • 2009: https://jacobian.org/writing/great- documentation/ •
2011: http://pyvideo.org/video/403/ pycon-2011--writing-great-documentation
Created Read the Docs to reduce friction to writing &
publishing docs
From Tool to Understanding
Read the Docs was started in 2010
None
Started Write the Docs in 2013
Learned about a whole community of writers
None
Documentation is more than a tool
Technical writers know what makes so ware understandable
More communities are valuing documentation
Documentation as guilt
Coding & Testing have objective results
Documentation is a “so skill”
All programmers feel guilt about this
Leads to putting off writing docs
We need to lower the barriers in our industry to
writing documentation
Why it matters
Empathy
You don’t want a community full of people who don’t
read documentation
Documentation is Outreach
None
My path is the path of many others
“I can’t say I’m self taught. I’ve been taught by
the people who wrote the documentation” — @soulshake
Thanks writethedocs.org readthedocs.org