Slide 1
Slide 1 text
@ryancanhelpyou @WordCampLanc #WCLanc
Oops!.. I Did It Again.
How documentation and journaling
can save you and your team from
making repeat mistakes
Ryan King
Slide 2
Slide 2 text
@ryancanhelpyou @WordCampLanc #WCLanc
TOC
Overview
Why Document?
Examples
Tips
Tools
WP Plugins
Resources
Slide 3
Slide 3 text
Examples
Slide 4
Slide 4 text
No content
Slide 5
Slide 5 text
No content
Slide 6
Slide 6 text
No content
Slide 7
Slide 7 text
No content
Slide 8
Slide 8 text
No content
Slide 9
Slide 9 text
TIPS
Slide 10
Slide 10 text
README
1
Sell your projects in the README
2 Include screenshot(s) - Animated GIFs!
3
Emojis - adds a personal touch & fun, gives it a
bit of personality and grabs attention
4
Link to your documentation, demos, and
examples on your website and in your
WordPress.org listing
Slide 11
Slide 11 text
No content
Slide 12
Slide 12 text
No content
Slide 13
Slide 13 text
TOOLS
Slide 14
Slide 14 text
NOTES
Slide 15
Slide 15 text
JOURNALING
Slide 16
Slide 16 text
No content
Slide 17
Slide 17 text
No content
Slide 18
Slide 18 text
No content
Slide 19
Slide 19 text
WP Plugins
Slide 20
Slide 20 text
No content
Slide 21
Slide 21 text
No content
Slide 22
Slide 22 text
No content
Slide 23
Slide 23 text
Resources
Slide 24
Slide 24 text
Articles & Sites:
Writing Effective Documentation: [Writing Effective Documentation For WordPress End Users —
Smashing (https://wp.smashingmagazine.com/2012/07/writing-effective-wordpress-documentation/ )
Cheatsheets: [Devhints — TL;DR for developer documentation](https://devhints.io/)
Read the Docs: [Home | Read the Docs](https://readthedocs.org/) - “We host the world's documentation.
Podcasts:
Request for Commits - Changelog Media - “Ep. 5: Documentation and the Value of Non-Code
Contributions”
The Changelog - Ep. 283: Devhints - TL;DR for Developer Documentation
Hello Tech Pros - Chad Bostick - Ep 268: “The UX of Technical Documentation” - George Mocharko
JS Party - Changelog Media - Ep. 8: Good Documentation
Slide 25
Slide 25 text
Thank you.
@ryancanhelpyou