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
8
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
18
A Tale of Teaching Rust
alilleybrinker
0
10
Efficient Nimber Calculation in Dots and Boxes
alilleybrinker
0
96
Other Decks in Programming
See All in Programming
オホーツクでコミュニティを立ち上げた理由―地方出身プログラマの挑戦 / TechRAMEN 2025 Conference
lemonade_37
2
450
階層化自動テストで開発に機動力を
ickx
1
480
大規模FlutterプロジェクトのCI実行時間を約8割削減した話
teamlab
PRO
0
450
MCP連携で加速するAI駆動開発/mcp integration accelerates ai-driven-development
bpstudy
0
280
CEDEC2025 長期運営ゲームをあと10年続けるための0から始める自動テスト ~4000項目を50%自動化し、月1→毎日実行にした3年間~
akatsukigames_tech
0
110
DynamoDBは怖くない!〜テーブル設計の勘所とテスト戦略〜
hyamazaki
0
190
PHPカンファレンス関西2025 基調講演
sugimotokei
6
1.1k
Reactの歴史を振り返る
tutinoko
1
180
WebAssemblyインタプリタを書く ~Component Modelを添えて~
ruccho
1
710
GUI操作LLMの最新動向: UI-TARSと関連論文紹介
kfujikawa
0
710
Terraform やるなら公式スタイルガイドを読もう 〜重要項目 10選〜
hiyanger
12
3k
Vibe coding コードレビュー
kinopeee
0
420
Featured
See All Featured
Building an army of robots
kneath
306
45k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
Producing Creativity
orderedlist
PRO
347
40k
Rails Girls Zürich Keynote
gr2m
95
14k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
36
2.5k
Bash Introduction
62gerente
614
210k
Side Projects
sachag
455
43k
Practical Orchestrator
shlominoach
190
11k
Done Done
chrislema
185
16k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
10
1k
Docker and Python
trallard
45
3.5k
Building Applications with DynamoDB
mza
96
6.5k
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?