Continuous Documentation for your code

Make your Python code to talk to you!

Anastasiia Tymoshchuk

Best Practice Python general

See in schedule

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,
- if this code is open source - easy to start contributing,
- easy to see purpose and motivation of each piece of code,
- easy to keep versioning for each new release of the code.

In this talk you will see the difference between documentation types and a demo in the end of the talk.

Type: Talk (30 mins); Python level: Beginner; Domain level: Beginner


Anastasiia Tymoshchuk

Scoutbee GmbH

Anastasiia works in the development for more than of 10 years (around 8 years in Python), including experience in e-commerce as well as game development. Every day she deals with lots of challenges when she has to consider software or library to start with, starting from the question how to build architecture and finishing with a deployment. Currently working as a Tech Lead, helping to build an engineering culture in her team and serve her team's needs as a Servant Leader.
Anastasiia is also one of the organisers of PyBerlin meetup based in Berlin.