Continuous Documentation: basics and advanced techniques

Documentation is an important part of each project, but it does not mean that it’s always up-to-date. Updating documentation continuously is quite a lot of work and not every project has a capacity to invest so much time into it, especially when a project is on a tight release schedule. This talk will show you the basics of a good documentation and you will learn about different types of documentation, how to use and when to write them. Anastasiia will also share her experience on how to introduce documentation as a part of your team’s daily routine and update it continuously.

From this talk you will learn:

• how to start with documentation for your code,
• how to make your documentation to update continuously,
• running Python code inside of your documentation with PyScript,
• documentation best practices.

After this talk you will be able to check out my repo with a few samples of different types of documentation as a part of continuous documentation for a dummy piece of code.