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
350
Understanding Documentation Systems
ericholscher
1
280
Introduction to Sphinx & Read the Docs Djangocon 2015
ericholscher
0
180
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
530
Documentation Journey
ericholscher
1
120
Other Decks in Technology
See All in Technology
SoccerNet GSRの紹介と技術応用:選手視点映像を提供するサッカー作戦盤ツール
mixi_engineers
PRO
1
160
Azure SynapseからAzure Databricksへ 移行してわかった新時代のコスト問題!?
databricksjapan
0
130
stupid jj tricks
indirect
0
7.8k
AI Agentと MCP Serverで実現する iOSアプリの 自動テスト作成の効率化
spiderplus_cb
0
470
o11yで育てる、強い内製開発組織
_awache
3
110
KAGのLT会 #8 - 東京リージョンでGAしたAmazon Q in QuickSightを使って、報告用の資料を作ってみた
0air
0
200
How to achieve interoperable digital identity across Asian countries
fujie
0
110
PLaMo2シリーズのvLLM実装 / PFN LLM セミナー
pfn
PRO
2
950
pprof vs runtime/trace (FlightRecorder)
task4233
0
150
全てGoで作るP2P対戦ゲーム入門
ponyo877
3
1.3k
定期的な価値提供だけじゃない、スクラムが導くチームの共創化 / 20251004 Naoki Takahashi
shift_evolve
PRO
3
290
コンテキストエンジニアリングとは? 考え方と応用方法
findy_eventslides
4
880
Featured
See All Featured
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
32
2.2k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.5k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
46
7.6k
Product Roadmaps are Hard
iamctodd
PRO
54
11k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
49
3.1k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
54
3k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
248
1.3M
RailsConf 2023
tenderlove
30
1.2k
Mobile First: as difficult as doing things right
swwweet
224
9.9k
Context Engineering - Making Every Token Count
addyosmani
4
170
We Have a Design System, Now What?
morganepeng
53
7.8k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
127
53k
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