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
180
【新卒研修資料】LLM・生成AI研修 / Large Language Model・Generative AI
brainpadpr
24
17k
Modern_Data_Stack最新動向クイズ_買収_AI_激動の2025年_.pdf
sagara
0
210
コンテキストエンジニアリングとは? 考え方と応用方法
findy_eventslides
4
900
組織観点からIAM Identity CenterとIAMの設計を考える
nrinetcom
PRO
1
180
AWSにおけるTrend Vision Oneの効果について
shimak
0
130
M5製品で作るポン置きセルラー対応カメラ
sayacom
0
150
Shirankedo NOCで見えてきたeduroam/OpenRoaming運用ノウハウと課題 - BAKUCHIKU BANBAN #2
marokiki
0
150
AIが書いたコードをAIが検証する!自律的なモバイルアプリ開発の実現
henteko
1
350
GA technologiesでのAI-Readyの取り組み@DataOps Night
yuto16
0
270
Goにおける 生成AIによるコード生成の ベンチマーク評価入門
daisuketakeda
2
100
業務自動化プラットフォーム Google Agentspace に入門してみる #devio2025
maroon1st
0
190
Featured
See All Featured
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
12
1.2k
The Cult of Friendly URLs
andyhume
79
6.6k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
30
2.9k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
140
34k
How GitHub (no longer) Works
holman
315
140k
Large-scale JavaScript Application Architecture
addyosmani
514
110k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
34
6.1k
Typedesign – Prime Four
hannesfritz
42
2.8k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
9
850
Fantastic passwords and where to find them - at NoRuKo
philnash
52
3.4k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
32
2.2k
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