Sign up or log in to watch the video
Continuous Documentation for Your Code
Anastasiia Tymoshchuk - 5 months ago
Do you document your code? Do you think it is important? Imagine that you need to get back to your code in 6 months 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 the purpose and motivation of each piece of code,- easy to keep versioning for each new release of the code. In this talk, I will show the difference between documentation types and will show a demo at the end of the talk.
Newest jobs
(Senior) Azure Cloud Architekt (m/w/d)
XIBIX Solutions GmbH
·
today
Munich, Germany
+3
Hybrid
Systemadministration Microsoft- & Linux-Server (inhouse)
Allgeier Cyris GmbH
·
today
Hamburg, Germany
Hybrid
Fachinformatiker (m/w/d) für ERP-Integration ohne Reisen
Allgeier Cyris GmbH
·
today
Hamburg, Germany
Hybrid
Java Software Engineer (all genders)
Zühlke Engineering GmbH
·
today
Stuttgart, Germany
Hybrid
Related videos