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
6
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
13
A Tale of Teaching Rust
alilleybrinker
0
5
Efficient Nimber Calculation in Dots and Boxes
alilleybrinker
0
96
Other Decks in Programming
See All in Programming
ISUCON研修おかわり会 講義スライド
arfes0e2b3c
1
440
ペアプロ × 生成AI 現場での実践と課題について / generative-ai-in-pair-programming
codmoninc
1
18k
地方に住むエンジニアの残酷な現実とキャリア論
ichimichi
5
1.5k
WebViewの現在地 - SwiftUI時代のWebKit - / The Current State Of WebView
marcy731
0
120
なぜ適用するか、移行して理解するClean Architecture 〜構造を超えて設計を継承する〜 / Why Apply, Migrate and Understand Clean Architecture - Inherit Design Beyond Structure
seike460
PRO
3
760
AI時代のソフトウェア開発を考える(2025/07版) / Agentic Software Engineering Findy 2025-07 Edition
twada
PRO
86
28k
Deep Dive into ~/.claude/projects
hiragram
14
2.5k
“いい感じ“な定量評価を求めて - Four Keysとアウトカムの間の探求 -
nealle
1
10k
AIともっと楽するE2Eテスト
myohei
6
2.6k
AI時代の『改訂新版 良いコード/悪いコードで学ぶ設計入門』 / ai-good-code-bad-code
minodriven
12
3.2k
0626 Findy Product Manager LT Night_高田スライド_speaker deck用
mana_takada
0
170
新メンバーも今日から大活躍!SREが支えるスケールし続ける組織のオンボーディング
honmarkhunt
5
7.2k
Featured
See All Featured
Agile that works and the tools we love
rasmusluckow
329
21k
How GitHub (no longer) Works
holman
314
140k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
229
22k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
26k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
29
9.6k
Building Adaptive Systems
keathley
43
2.7k
A Tale of Four Properties
chriscoyier
160
23k
Rails Girls Zürich Keynote
gr2m
95
14k
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
Making Projects Easy
brettharned
116
6.3k
Fireside Chat
paigeccino
37
3.5k
We Have a Design System, Now What?
morganepeng
53
7.7k
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?