Главная
Study mode:
on
1
Intro
2
What are they trying to achieve?
3
Assume nothing
4
It's not a manual
5
Interactivity
6
Involve the reader
7
Passive vs Active
8
Keep it short
9
Structure
10
Consistency
11
Format and editing
12
Write your own
Description:
Discover how to create clear, concise, and usable documentation for your coding projects in this 49-minute conference talk by Chris Ward from Crate.IO. Learn why documentation is crucial, how to explain your point and motivation, create context and meaning, write clear copy, and develop meaningful examples and tutorials. Explore documentation systems, formats, and integration into build processes. Gain insights on testing and versioning documentation. Understand the importance of assuming nothing, keeping content interactive and concise, maintaining consistency, and involving the reader. Improve your technical writing skills to enhance the usability of your libraries and tools for other developers.

Explain Yourself! Documentation for Better Code

Linux Foundation
Add to list