This course aims to improve code quality through effective documentation practices. Participants will learn the importance of well-written instructions, informative comments, and clear documentation to make code more accessible and understandable. The course covers various aspects of technical writing, including creating good documentation, writing README files, and crafting release notes. The teaching method includes a mix of informative comments, scripted screencasts, and practical examples. This course is intended for developers who want to enhance their code quality, facilitate knowledge transfer to others, and improve their understanding of their own work.
Overview
Syllabus
Welcome
Agenda
Why Alexandra started a blog
Alexandras goal
I am lost
Documentation is a tool
You are already writing
The kind of technical writing I do
Good docs
Cliffs Notes
Writing
Teaching CSS
Learning is a twostep process
Write documentation first
Writing is good for you
I love sprinkles
Confetti cake
Everyone agrees
Why are you creating documentation
Does your document exist to inform
Compliance
Why
Audience
Future Self
Reassignment
Internal documentation
Know your audience
The curse of knowledge
Spell out words
Define your deliverables
Write while you code
Google Publisher Tag
Bad Comments
Write a Readme
What Makes a Good Readme
Bonus Points
Stepbystep
Bad instructions
Templates
Release Notes
Bad Release Notes
Performance Improvement
Better Release Notes
You Can Now
X Now Does Y
X No Longer Does Y
Blog Posts
Taught by
PHP UK Conference
