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
Hypervel - A Coroutine Framework for Laravel Artisans
albertcht
1
120
ISUCON研修おかわり会 講義スライド
arfes0e2b3c
1
440
Result型で“失敗”を型にするPHPコードの書き方
kajitack
5
650
#QiitaBash MCPのセキュリティ
ryosukedtomita
1
1.3k
効率的な開発手段として VRTを活用する
ishkawa
0
140
AIプログラマーDevinは PHPerの夢を見るか?
shinyasaita
1
220
技術同人誌をMCP Serverにしてみた
74th
1
640
20250628_非エンジニアがバイブコーディングしてみた
ponponmikankan
0
680
PicoRuby on Rails
makicamel
2
130
Discover Metal 4
rei315
2
130
VS Code Update for GitHub Copilot
74th
2
640
Azure AI Foundryではじめてのマルチエージェントワークフロー
seosoft
0
170
Featured
See All Featured
Music & Morning Musume
bryan
46
6.6k
Large-scale JavaScript Application Architecture
addyosmani
512
110k
The Cost Of JavaScript in 2023
addyosmani
51
8.5k
Building an army of robots
kneath
306
45k
Intergalactic Javascript Robots from Outer Space
tanoku
271
27k
Balancing Empowerment & Direction
lara
1
430
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
130
19k
Navigating Team Friction
lara
187
15k
Building a Modern Day E-commerce SEO Strategy
aleyda
42
7.4k
The Power of CSS Pseudo Elements
geoffreycrofte
77
5.9k
Statistics for Hackers
jakevdp
799
220k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
34
5.9k
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?