Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

Linux Foundation

Explain Yourself! Documentation for Better Code

Linux Foundation via YouTube

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

Reviews

5.0 rating, based on 1 Class Central review

Start your review of Explain Yourself! Documentation for Better Code

  • Prabakaran T
    "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."

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.