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

Use Markdown to shortly create a phenomenal documentation web page to your initiatives

Mission documentation is important. Very needed, I might emphasize.

At first of my profession, I realized the onerous means {that a} challenge have to be documented.

Let’s return in time — to the 2000s — after I was working as a Buyer Consultant for giant US corporations. I used to be a part of a staff and my colleagues and I had joined the corporate across the similar month. So, for some time, there was no want to fret as a result of no person was happening trip only a few 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 significant half in my profession.

The day the primary individual took just a few days off, I panicked! I started working and I didn’t know what to do and even the place to begin. The duties stored coming and piling up whereas I used to be attempting to determine tips on how to course of them.

In the long run, the whole lot turned out effectively. I used to be in a position to 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 staff motion, like promotions or…