Completed
Write a Readme
Class Central Classrooms beta
YouTube videos curated by Class Central.
Classroom Contents
Improve Your Code With Documentation
Automatically move to the next video in the Classroom when playback concludes
- 1 Welcome
- 2 Agenda
- 3 Why Alexandra started a blog
- 4 Alexandras goal
- 5 I am lost
- 6 Documentation is a tool
- 7 You are already writing
- 8 The kind of technical writing I do
- 9 Good docs
- 10 Cliffs Notes
- 11 Writing
- 12 Teaching CSS
- 13 Learning is a twostep process
- 14 Write documentation first
- 15 Writing is good for you
- 16 I love sprinkles
- 17 Confetti cake
- 18 Everyone agrees
- 19 Why are you creating documentation
- 20 Does your document exist to inform
- 21 Compliance
- 22 Why
- 23 Audience
- 24 Future Self
- 25 Reassignment
- 26 Internal documentation
- 27 Know your audience
- 28 The curse of knowledge
- 29 Spell out words
- 30 Define your deliverables
- 31 Write while you code
- 32 Google Publisher Tag
- 33 Bad Comments
- 34 Write a Readme
- 35 What Makes a Good Readme
- 36 Bonus Points
- 37 Stepbystep
- 38 Bad instructions
- 39 Templates
- 40 Release Notes
- 41 Bad Release Notes
- 42 Performance Improvement
- 43 Better Release Notes
- 44 You Can Now
- 45 X Now Does Y
- 46 X No Longer Does Y
- 47 Blog Posts
