Overview
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.
Syllabus
Intro
What are they trying to achieve?
Assume nothing
It's not a manual
Interactivity
Involve the reader
Passive vs Active
Keep it short
Structure
Consistency
Format and editing
Write your own
Taught by
Linux Foundation
Tags
Reviews
5.0 rating, based on 2 Class Central reviews
Showing Class Central Sort
-
The program was very useful and it defiantly will help with making documentation more succinct. This program was simple and very easy to follow.
-
"Chris Ward's documentation guide is a valuable resource for improving code quality through effective documentation practices. It provides insightful tips and examples, making it a must-read for developers seeking to enhance their coding skills."