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
Hello and Welcome: Documentation in the Rust Ec...
Search
Andrew Lilley Brinker
April 10, 2025
Programming
0
4
Hello and Welcome: Documentation in the Rust Ecosystem
Andrew Lilley Brinker
April 10, 2025
Tweet
Share
More Decks by Andrew Lilley Brinker
See All by Andrew Lilley Brinker
Memory Safety and the Future of Vulnerabilities
alilleybrinker
0
12
A Tale of Teaching Rust
alilleybrinker
0
4
Efficient Nimber Calculation in Dots and Boxes
alilleybrinker
0
96
Other Decks in Programming
See All in Programming
AIコーディング道場勉強会#2 君(エンジニア)たちはどう生きるか
misakiotb
1
250
Is Xcode slowly dying out in 2025?
uetyo
1
190
エンジニア向け採用ピッチ資料
inusan
0
160
エラーって何種類あるの?
kajitack
5
310
AWS CDKの推しポイント 〜CloudFormationと比較してみた〜
akihisaikeda
3
310
WindowInsetsだってテストしたい
ryunen344
1
190
なぜ適用するか、移行して理解するClean Architecture 〜構造を超えて設計を継承する〜 / Why Apply, Migrate and Understand Clean Architecture - Inherit Design Beyond Structure
seike460
PRO
1
690
C++20 射影変換
faithandbrave
0
530
Team operations that are not burdened by SRE
kazatohiei
1
210
iOSアプリ開発で 関数型プログラミングを実現する The Composable Architectureの紹介
yimajo
2
210
「Cursor/Devin全社導入の理想と現実」のその後
saitoryc
0
160
GoのGenericsによるslice操作との付き合い方
syumai
3
690
Featured
See All Featured
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
46
9.6k
Balancing Empowerment & Direction
lara
1
370
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
29
2.7k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
32
2.3k
Building a Modern Day E-commerce SEO Strategy
aleyda
42
7.3k
Learning to Love Humans: Emotional Interface Design
aarron
273
40k
Making the Leap to Tech Lead
cromwellryan
134
9.3k
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
tammyeverts
5
210
YesSQL, Process and Tooling at Scale
rocio
173
14k
For a Future-Friendly Web
brad_frost
179
9.8k
Gamification - CAS2011
davidbonilla
81
5.3k
Transcript
Hello and Welcome Documentation in the Rust Ecosystem (By Andrew
Brinker)
How you say hello Act One
What does the word “Docs” include?
The Meet cute the black triangle the walkthrough the reference
The Meet Cute “What is this?” “Why should I care?”
The Black Triangle The simplest code to do something good
The Walkthrough explain like you’re in the room
The Reference the complete api & every explanation
Docs are the first thing people see
First impressions are important
good Docs are needed for productivity!
Frequently asked questions Act Two
Three phases
Community Outreach
Reach as far as possible
Take All Input seriously
Check for existing sources
The First Draft
You don’t need to know everything
It’s Okay to write poorly
Some docs are better than no docs
Refinement
Don’t fear the delete key
Get outside opinions
Listen
In The End Total time: ≈ 4 months Total comments:
416 Total commits: 42 Number of participants: 29 And it’s still not done!
Good docs… • Require empathy • Require collaboration • Require
time • Don’t happen on accident
Docs in the Rust ecosystem Act Three
So many crates! Number of crates 6,639 Number of downloads
79,771,988 (As of October 24th at 7:08pm PST)
How Are the docs? Quality % of top 100 crates
No docs provided 25% Poor quality 13% Fair quality 15% Good quality 47%
They’re Pretty Good!
But there’s room for improvement
Lots of docs are incomplete
Lots of docs don’t explain enough
Good news, Everyone!
The foundation is already laid
The rust project cares about docs!
Rustdoc is good, and getting better!
It’s a question of focus and planning
where do we go from here? Act Four
crate developers
Review your docs portfolio
Offer mentored docs issues
Treat docs contributors like code contributors
consider “doc days” or “doc sprints”
crate users
report docs issues when you have them
Participate in docs discussions
contribute docs improvements
Everyone
Let’s make rust more welcoming and productive together
Questions?