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
11
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
21
A Tale of Teaching Rust
alilleybrinker
0
11
Efficient Nimber Calculation in Dots and Boxes
alilleybrinker
0
97
Other Decks in Programming
See All in Programming
HTMLの品質ってなんだっけ? “HTMLクライテリア”の設計と実践
unachang113
4
2.7k
Cache Me If You Can
ryunen344
2
640
詳解!defer panic recover のしくみ / Understanding defer, panic, and recover
convto
0
230
はじめてのMaterial3 Expressive
ym223
2
250
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
330
アセットのコンパイルについて
ojun9
0
120
そのAPI、誰のため? Androidライブラリ設計における利用者目線の実践テクニック
mkeeda
2
260
Processing Gem ベースの、2D レトロゲームエンジンの開発
tokujiros
2
120
250830 IaCの選定~AWS SAMのLambdaをECSに乗り換えたときの備忘録~
east_takumi
0
390
ソフトウェアテスト徹底指南書の紹介
goyoki
1
150
Vue・React マルチプロダクト開発を支える Vite
andpad
0
110
ぬるぬる動かせ! Riveでアニメーション実装🐾
kno3a87
1
210
Featured
See All Featured
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
18
1.1k
A designer walks into a library…
pauljervisheath
207
24k
Site-Speed That Sticks
csswizardry
10
810
[RailsConf 2023] Rails as a piece of cake
palkan
57
5.8k
Thoughts on Productivity
jonyablonski
70
4.8k
Visualization
eitanlees
148
16k
Gamification - CAS2011
davidbonilla
81
5.4k
Music & Morning Musume
bryan
46
6.8k
Fireside Chat
paigeccino
39
3.6k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
33
2.4k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
12
1.1k
Unsuck your backbone
ammeep
671
58k
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?