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

YouTube

Improve Your Code With Documentation

PHP UK Conference via YouTube

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
Discover how to enhance your code through effective documentation in this PHP UK Conference talk. Learn the importance of well-written instructions, informative code comments, clearly scripted screencasts, and smart information architecture in making complex code accessible to new developers. Explore the benefits of documentation for teaching, code handover, and self-understanding. Gain insights into various documentation types, including blog posts, internal documentation, READMEs, and release notes. Understand the significance of knowing your audience, avoiding the curse of knowledge, and defining clear deliverables. Master techniques for writing while coding, creating effective comments, and structuring informative release notes. Improve your technical writing skills and learn how documentation can benefit both you and future developers in this comprehensive guide to better code documentation.

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

Reviews

Start your review of Improve Your Code With Documentation

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.