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

Use Markdown to shortly create an attractive documentation web page in your tasks

Picture created with DALL·E by OpenAI. https://openai.com. MkDocs in Python.

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

Firstly of my profession, I discovered the exhausting manner {that a} venture should be documented.

Let’s return in time — to the 2000s — once I was working as a Buyer Consultant for giant US corporations. I used to be a part of a crew 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 occurring trip only a few weeks or months after beginning a brand new job.

Nonetheless, after a while, it inevitably would occur. And we had 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 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 start out. The duties saved coming and piling up whereas I used to be making an attempt to determine course of them.

Ultimately, all the things 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 time without work or crew motion, like promotions or…