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
220
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
210
Understanding Documentation Systems - ConFoo Vancouver 2016
ericholscher
0
270
Python Documentation: Past, Present, & Future
ericholscher
3
290
Understanding Documentation Systems
ericholscher
1
260
Introduction to Sphinx & Read the Docs Djangocon 2015
ericholscher
0
150
Announcing Read the Docs for Business
ericholscher
1
220
Write the Docs NA 2014 Introduction
ericholscher
0
140
Introduction to Sphinx & Read the Docs
ericholscher
3
390
Documentation Journey
ericholscher
1
110
Other Decks in Technology
See All in Technology
Privacy Sandbox on Android / DroidKaigi 2024
7pairs
1
280
o1のAPIで実験してみたが 制限きつすぎて辛かった話
pharma_x_tech
0
230
フルカイテン株式会社 採用資料
fullkaiten
0
32k
AIを活用した柔軟かつ効率的な社内リソース検索への取り組み
cygames
0
210
不動産 x AIことはじめ~データの真価を拓くために
estie
0
130
【株式会社ELYZA】|GENIAC成果報告会 自社開発モデルプレゼンテーション
elyza
1
410
eBPFのこれまでとこれから
yutarohayakawa
10
3.3k
Analytics-Backed App Widget Development - Served with Jetpack Glance
miyabigouji
0
630
不動産売買取引におけるAIの可能性とプロダクトでのAI活用
zabio3
0
270
PdMはどのように全てのスピードを上げられるか ~ 非連続進化のための具体的な取り組み ~
sansantech
PRO
4
1.4k
Developer Experienceを向上させる基盤づくりの取り組み事例集
coconala_engineer
0
160
Next.js のページ遷移を全力で止める
ypresto
9
3.6k
Featured
See All Featured
Typedesign – Prime Four
hannesfritz
39
2.3k
Design by the Numbers
sachag
277
19k
The Power of CSS Pseudo Elements
geoffreycrofte
71
5.3k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
28
8.9k
Teambox: Starting and Learning
jrom
131
8.7k
What's new in Ruby 2.0
geeforr
340
31k
10 Git Anti Patterns You Should be Aware of
lemiorhan
653
58k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.3k
Building a Scalable Design System with Sketch
lauravandoore
459
32k
Designing on Purpose - Digital PM Summit 2013
jponch
114
6.8k
Building a Modern Day E-commerce SEO Strategy
aleyda
36
6.8k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
123
18k
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