Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

The Self Documenting Developer -- WordCamp Phoenix 2020

228 views

Published on

Slides from my presentation at WordCamp Phoenix 2020.

Published in: Software
  • Be the first to comment

  • Be the first to like this

The Self Documenting Developer -- WordCamp Phoenix 2020

  1. 1. @mlteal | #WCPHX | 2020 The Self-Documenting Developer
  2. 2. Maura Teal (@mlteal) Software Engineer at Pagely and NorthStack @mlteal | #WCPHX | 2020
  3. 3. @mlteal | #WCPHX | 2020 Back in the day…
  4. 4. @mlteal | #WCPHX | 2020 1. https://books.google.com/books?id=pq-eT9Lz6gkC&lpg=PA91&pg=PA87#v=onepage&q&f=false
  5. 5. @mlteal | #WCPHX | 2020 “In many shops, more time is spent trying to understand software than [any other task]” 1. https://books.google.com/books?id=pq-eT9Lz6gkC&lpg=PA91&pg=PA87#v=onepage&q&f=false
  6. 6. @mlteal | #WCPHX | 2020 A Little 90’s Nostalgia 1. https://thenextweb.com/insider/2011/08/06/20-years-ago-today-the-world-wide-web-opened-to-the-public/
  7. 7. @mlteal | #WCPHX | 2020
  8. 8. @mlteal | #WCPHX | 2020 Code is constantly changing
  9. 9. @mlteal | #WCPHX | 2020 Accept it.
  10. 10. @mlteal | #WCPHX | 2020 In the modern world
  11. 11. @mlteal | #WCPHX | 2020 Making sense of it all
  12. 12. @mlteal | #WCPHX | 2020 Rules to live by • Start simple • Document as you go • Comment your code
  13. 13. @mlteal | #WCPHX | 2020 Rules to live by • Start simple • Document as you go • Note where your projects and processes live
  14. 14. @mlteal | #WCPHX | 2020
  15. 15. @mlteal | #WCPHX | 2020 You decide what you support
  16. 16. @mlteal | #WCPHX | 2020 New feature = New documentation
  17. 17. @mlteal | #WCPHX | 2020 Create & share the process• Slack request -> GH Issue • Slack question -> GH README reference
 -> GH Code reference • Email request -> GH Issue
  18. 18. @mlteal | #WCPHX | 2020 • GitHub Issue Update -> Slack • New Release -> Slack • Documentation updated -> note in Slack • Via Daily/Weekly Standups (Standuply Bot) • Via CI/CD pipeline (we use Storybook and Redoc) 1. https://standuply.com/ 2. https://storybook.js.org/ 3. https://github.com/Redocly/redoc
  19. 19. @mlteal | #WCPHX | 2020 Integrations FTW
  20. 20. @mlteal | #WCPHX | 2020 Good documentation comes from those who build & use the product
  21. 21. @mlteal | #WCPHX | 2020
  22. 22. @mlteal | #WCPHX | 2020 Maura Teal @mlteal

×