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.

PyCon Estonia: Contemporary Documentation

41 views

Published on

My slides from my talk Contemporary Documentation.

Find more info about it here: https://hamatti.org/talks/contemporary-documentation/

Published in: Technology
  • Be the first to comment

  • Be the first to like this

PyCon Estonia: Contemporary Documentation

  1. 1. CONTEMPORARY DOCUMENTATION PyCon Estonia • Juha-Matti Santala • October 3rd 2019
  2. 2. CONTEMPORARY /kənˈtɛm.pəˌɹɛɹ.i/ 1. From the same time period, 
 coexistent in time. 
 2. Modern, of the present age @hamattiPyCon Estonia 2019
  3. 3. HI, I’M JUHIS Developer Advocate @ Futurice Founder of Turku <3 Frontend Background in startups & consulting @hamatti in Twitter from Helsinki, ! @hamattiPyCon Estonia 2019
  4. 4. @hamattiPyCon Estonia 2019 TEAMS CHANGE
  5. 5. DOCUMENTATION SHOULD @hamattiPyCon Estonia 2019 PROVIDE CONTEXT
  6. 6. (MOST OF THE) DOCUMENTATION IS A LIVING ORGANISM @hamattiPyCon Estonia 2019 (README, API DOCS, CODE COMMENTS)
  7. 7. COMMIT MESSAGES @hamattiPyCon Estonia 2019 CODE REVIEW STORIES &
 TASKS 3 BRANCHES
  8. 8. @hamattiPyCon Estonia 2019 It’s hard because the reward comes later
  9. 9. COMMIT MESSAGE @hamattiPyCon Estonia 2019
  10. 10. @hamattiPyCon Estonia 2019 https://xkcd.com/1296/
  11. 11. @hamattiPyCon Estonia 2019 “What would you like to know two years from now?”
  12. 12. @hamattiPyCon Estonia 2019 “What would you ask from a colleague who wrote this two years ago?”
  13. 13. @hamattiPyCon Estonia 2019 https: //chris.beams.io/posts/git-commit/
  14. 14. CODE REVIEW @hamattiPyCon Estonia 2019
  15. 15. https://github.com/facebook/react/pull/16302
  16. 16. WRITE IT DOWN @hamattiPyCon Estonia 2019 ASK A LOT OF QUESTIONS DON’T DELETE COMMENTS
  17. 17. STORIES & TASKS @hamattiPyCon Estonia 2019
  18. 18. STORIES & TASKS @hamattiPyCon Estonia 2019 Origin / Business Driver How to reproduce? Definition of Done Clarifying questions
  19. 19. WRITE IT DOWN @hamattiPyCon Estonia 2019
  20. 20. DOCUMENTATION WORKFLOW @hamattiPyCon Estonia 2019
  21. 21. @hamattiPyCon Estonia 2019
  22. 22. @hamattiPyCon Estonia 2019
  23. 23. @hamattiPyCon Estonia 2019
  24. 24. @hamattiPyCon Estonia 2019
  25. 25. @hamattiPyCon Estonia 2019
  26. 26. @hamattiPyCon Estonia 2019
  27. 27. @hamattiPyCon Estonia 2019
  28. 28. RECAP @hamatti COMMIT MSG, CODE REVIEW & ISSUES “WHAT WOULD I WANT TO KNOW IN 2 YEARS” WRITE IT DOWN PyCon Estonia 2019
  29. 29. FRIDAY HUG @hamattiPyCon Estonia 2019
  30. 30. THANK YOU! @hamattiPyCon Estonia 2019 @hamatti https://hamatti.org juhis@futurice.com PS. I run a developer newsletter called Dev Breakfast at hello.futurice.com/dev-breakfast

×