Overview
Learn how to create clear, concise, and usable documentation for your projects. This course covers the importance of documentation, creating context, writing clear copy, providing meaningful examples, documentation systems, testing docs, and versioning. The course emphasizes the need for programmers to explain themselves effectively and offers insights into technical writing and editing. The intended audience includes developers looking to enhance their documentation skills.
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 1 Class Central review
Showing Class Central Sort
-
"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."