Member-only story
Documenting Python Projects with MkDocs
Use Markdown to quickly create a beautiful documentation page for your projects
Introduction
Project documentation is necessary. Very necessary, I would emphasize.
At the beginning of my career, I learned the hard way that a project must be documented.
Let’s go back in time — to the 2000s — when I was working as a Customer Representative for large US companies. I was part of a team and my colleagues and I had joined the company around the same month. So, for a while, there was no need to worry because nobody was going on vacation just a few weeks or months after starting a new job.
However, after some time, it inevitably would happen. And we were all assigned to back up each other. That is when documentation started to play a major part in my career.
The day the first person took a few days off, I panicked! I got to work and I didn’t know what to do or even where to start. The tasks kept coming and piling up while I was trying to figure out how to process them.
In the end, everything turned out well. I was able to figure it out and move on. But from that day on, I knew that documentation needed to be in place for any time off or team movement, like promotions or…
