Documenting Python Projects with MkDocs | by Gustavo Santos | Nov, 2024

Use Markdown to rapidly create an exquisite documentation web page in your tasks

Venture documentation is critical. Very mandatory, I might emphasize.

In the beginning of my profession, I discovered the laborious method {that a} challenge have to be documented.

Let’s return in time — to the 2000s — once I was working as a Buyer Consultant for big US corporations. I used to be a part of a crew and my colleagues and I had joined the corporate across the identical month. So, for some time, there was no want to fret as a result of no one was happening trip just some weeks or months after beginning a brand new job.

Nevertheless, after a while, it inevitably would occur. And we have been all assigned to again up one another. That’s when documentation began to play a serious half in my profession.

The day the primary particular person took a number of days off, I panicked! I started working and I didn’t know what to do and even the place to begin. The duties saved coming and piling up whereas I used to be attempting to determine the right way to course of them.

Ultimately, every thing turned out effectively. I used to be capable of determine it out and transfer on. However from that day on, I knew that documentation wanted to be in place for any day off or crew motion, like promotions or…