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
210
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
200
Understanding Documentation Systems - ConFoo Vancouver 2016
ericholscher
0
260
Python Documentation: Past, Present, & Future
ericholscher
3
270
Understanding Documentation Systems
ericholscher
1
240
Introduction to Sphinx & Read the Docs Djangocon 2015
ericholscher
0
140
Announcing Read the Docs for Business
ericholscher
1
210
Write the Docs NA 2014 Introduction
ericholscher
0
130
Introduction to Sphinx & Read the Docs
ericholscher
3
360
Documentation Journey
ericholscher
1
100
Other Decks in Technology
See All in Technology
社内勉強会運営のコツ
senoo
6
1.1k
SIEMを用いて、セキュリティログ分析の可視化と分析を実現し、PDCAサイクルを回してみた
coconala_engineer
0
220
Databricks におけるデータエンジニアリング
databricksjapan
0
380
0→1開発における技術選定において一番大切なこと
bicstone
1
330
コンテナセキュリティの基本と脅威への対策
kyohmizu
3
700
Delivering Millions of Messages within seconds @ Duolingo
pelelgrino
0
340
「共通基盤」を超えよ! 今、Platform Engineeringに取り組むべき理由
jacopen
25
5.9k
Garoon 開発チーム / Garoon development team
cybozuinsideout
PRO
2
2.9k
o11y入門_外形監視を利用したWebアプリケーションへの最適なモニタリング_TechBrew
k5k
3
100
マルチアカウント環境への発見的統制の導入
ch1aki
1
1.3k
インシデントレスポンスのライフサイクルを廻すポイントってなに / Pinpoints of Incidentresponse Lifecycle for Operation
sakaitakeshi
1
300
Data and AI Governance: Existing Challenges and Emerging Trends
scotthsieh825
0
160
Featured
See All Featured
The Cult of Friendly URLs
andyhume
74
5.7k
Designing with Data
zakiwarfel
95
4.8k
Visualization
eitanlees
135
14k
Clear Off the Table
cherdarchuk
83
310k
GraphQLとの向き合い方2022年版
quramy
31
12k
Making Projects Easy
brettharned
108
5.5k
Git: the NoSQL Database
bkeepers
PRO
422
63k
10 Git Anti Patterns You Should be Aware of
lemiorhan
646
57k
Fantastic passwords and where to find them - at NoRuKo
philnash
36
2.5k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
186
16k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3k
Bootstrapping a Software Product
garrettdimon
PRO
301
110k
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