Continuous Documentation for your code

Do you document your code? Do you think it is important? Imagine that you need to get back to your code in 6 month after you wrote it, there is always a big possibility that you will have to spend some time to find out how this code works. Or if someone else wrote some code, which is already in production and your task is to fix a bug in it and there is no documentation and no one actually knows what this code does.
There are more benefits of implementing continuous documentation for the code:
- easy to onboard new team members,
- easy to share knowledge,
- easy to keep versioning, and more.

Transcript

1. Continuous Documentation for your code Anastasiia Tymoshchuk - Lead Engineer May 18-19-20, 2021
2. anastasiatymo • Lead Dev at Scoutbee in Berlin • PyBerlin organiser 
 https://www.meetup.com/PyBerlin/ • 11 years in so ft ware development • 7 years in Python • Happy Pythonista 🐍 😊 Few words about myself
3. anastasiatymo Photo by Wesley Tingey on Unsplash Do you document your code?
4. anastasiatymo Me 10 years ago..
5. anastasiatymo Photo by Courtney Chestnut on Unsplash Let the future begin...
6. anastasiatymo Photo by Sharon McCutcheon on Unsplash
7. anastasiatymo Photo by Sharon McCutcheon on Unsplash
8. anastasiatymo Photo by Sharon McCutcheon on Unsplash
9. anastasiatymo Photo by Sharon McCutcheon on Unsplash
10. anastasiatymo Photo by MUNMUN SINGH on Unsplash Sad Code
11. anastasiatymo Photo by MUNMUN SINGH on Unsplash Sad Code
12. anastasiatymo Photo by MUNMUN SINGH on Unsplash Sad Code
13. anastasiatymo Photo by Sharon McCutcheon on Unsplash Listen carefully...
14. anastasiatymo Photo by Sharon McCutcheon on Unsplash
15. anastasiatymo Photo by Sharon McCutcheon on Unsplash Learning-oriented approach - Tutorials Source: https://documentation.divio.com/ "Tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind."
16. anastasiatymo Photo by Sharon McCutcheon on Unsplash Problem-oriented approach - How-To Guides Source: https://documentation.divio.com/ "How-to guides take the reader through the steps required to solve a real-world problem. They are recipes, directions to achieve a speci fi c end."
17. anastasiatymo Photo by Sharon McCutcheon on Unsplash Understanding-oriented approach - Explanation Source: https://documentation.divio.com/ "Explanation, or discussions, clarify and illuminate a particular topic. They broaden the documentation’s coverage of a topic."
18. anastasiatymo Photo by Sharon McCutcheon on Unsplash Information-oriented approach - Reference Source: https://documentation.divio.com/ "Reference guides have one job only: to describe. They are code-determined, because ultimately that’s what they describe: key classes, functions, APIs, and so they should list things like functions, fi elds, attributes and methods, and set out how to use them."
19. anastasiatymo Photo by Beatriz Pérez Moya on Unsplash "Someone, who can teach you a lesson, but not a teacher. Someone, who can guide you to a goal, but not a tour guide. Someone, who can tell you everything about technical specs of your functions, but not an encyclopaedia. Someone, who can explain you a particular topic, to help you to understand, but not google."
20. anastasiatymo Photo by Dollar Gill on Unsplash "There is a secret that needs to be understood in order to write good so ft ware documentation: there isn’t one thing called documentation, there are four." Source: https://documentation.divio.com/ Was it all about you? Are you Documentation?
21. anastasiatymo Photo by Dollar Gill on Unsplash Would you document your code?
22. anastasiatymo • people forget things • people leave the code alone • new people come to contribute
23. anastasiatymo • choose main source/tool for documentation • make sure that it's up-to-date
24. anastasiatymo Photo by Beatriz Pérez Moya on Unsplash How to start? • start as simple as possible • go to version controlled docs
25. anastasiatymo Photo by Beatriz Pérez Moya on Unsplash • https://documentation.divio.com/ • https://understandlegacycode.com/blog/ where-to-put-documentation/
26. anastasiatymo Photo by Beatriz Pérez Moya on Unsplash Do you use Python? • start with Sphinx • try Read The Docs
27. anastasiatymo Photo by Beatriz Pérez Moya on Unsplash Do you use React? • make sure you documented shared components • try existing tools: 
 Storybook, Bit, Styleguidist https://blog.bitsrc.io/5-ways-to-document-react-components-in-2020-ecf60f24dee8
28. anastasiatymo Photo by Courtney Chestnut on Unsplash https://github.com/atymoshchuk/simple_docs_setup Demo?👩💻
29. anastasiatymo Photo by Amy Shamblen: https://unsplash.com/photos/lJt-3NUFng4 I would love to hear back from you! https://www.meetup.com/PyBerlin/ https://atymo.me/ Thank you! https://github.com/atymoshchuk/simple_docs_setup