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
510
Documentation Journey
ericholscher
1
120
Other Decks in Technology
See All in Technology
LLMエージェント時代に適応した開発フロー
hiragram
1
410
小さなチーム 大きな仕事 - 個人開発でAIをフル活用する
himaratsu
0
120
第4回 関東Kaggler会 [Training LLMs with Limited VRAM]
tascj
12
1.8k
実践アプリケーション設計 ②トランザクションスクリプトへの対応
recruitengineers
PRO
3
170
攻撃と防御で実践するプロダクトセキュリティ演習~導入パート~
recruitengineers
PRO
2
200
浸透しなさいRFC 5322&7208
hinono
0
120
モダンフロントエンド 開発研修
recruitengineers
PRO
3
350
AIドリブンのソフトウェア開発 - うまいやり方とまずいやり方
okdt
PRO
9
630
Goss: New Production-Ready Go Binding for Faiss #coefl_go_jp
bengo4com
0
1.1k
見てわかるテスト駆動開発
recruitengineers
PRO
5
360
新卒(ほぼ)専業Kagglerという選択肢
nocchi1
1
2.3k
Effective Match Types - Scala Days 2025
bishabosha
1
110
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
73
5k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
46
7.6k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
110
20k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
PRO
183
54k
Typedesign – Prime Four
hannesfritz
42
2.8k
Site-Speed That Sticks
csswizardry
10
790
Into the Great Unknown - MozCon
thekraken
40
2k
Building a Modern Day E-commerce SEO Strategy
aleyda
43
7.5k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
131
19k
Building Adaptive Systems
keathley
43
2.7k
The Language of Interfaces
destraynor
160
25k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
48
9.6k
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