Documentando Projetos Python com MkDocs
Use Markdown para criar uma bela página de documentação para seus projetos.
Introdução
A documentação do projeto é necessária. Muito necessária, eu enfatizaria.
No início da minha carreira, aprendi da maneira mais difícil que um projeto deve ser documentado.
Vamos voltar no tempo — para os anos 2000 — quando eu trabalhava como Representante de Clientes para grandes empresas dos EUA. Eu fazia parte de uma equipe e meus colegas e eu entramos na empresa por volta do mesmo mês. Então, por um tempo, não havia necessidade de se preocupar porque ninguém estava saindo de férias apenas algumas semanas ou meses depois de começar um novo emprego.
No entanto, depois de algum tempo, isso inevitavelmente aconteceria. E todos nós fomos designados para dar suporte uns aos outros. Foi quando a documentação começou a desempenhar um papel importante na minha carreira.
No dia em que a primeira pessoa tirou alguns dias de folga, entrei em pânico! Cheguei ao trabalho e não sabia o que fazer ou mesmo por onde começar. As tarefas continuaram chegando e se acumulando enquanto eu tentava descobrir como processá-las.
No final, tudo deu certo. Consegui descobrir e seguir em frente. Mas daquele dia em diante, eu sabia que a documentação precisava…
