Improve Your Code With Documentation

Improve Your Code With Documentation

PHP UK Conference via YouTube Direct link

Internal documentation

26 of 47

26 of 47

Internal documentation

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

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.