Documentar proyectos de Python con MkDocs | de Gustavo Santos | noviembre 2024

Documentar proyectos de Python con MkDocs | de Gustavo Santos | noviembre 2024

Utilice Markdown para crear rápidamente una hermosa página de documentación para sus proyectos

Imagen creada con DALL·E por OpenAI. MkDocs en Python.

Se requiere documentación del proyecto. Muy necesario, subrayo.

Al principio de mi carrera, aprendí por las malas que un proyecto debe estar documentado.

Retrocedamos en el tiempo hasta la década de 2000, cuando trabajaba como representante de clientes para grandes empresas estadounidenses. Yo era parte de un equipo y mis colegas y yo nos unimos a la empresa aproximadamente el mismo mes. Así que durante un tiempo no hubo necesidad de preocuparse porque nadie se iba de vacaciones apenas unas semanas o meses después de comenzar un nuevo trabajo.

Sin embargo, después de un tiempo, esto sucedería inevitablemente. Y todos éramos responsables de apoyarnos unos a otros. es en ese momento documentación comenzó a desempeñar un papel importante en mi carrera.

El día que la primera persona se tomó unos días libres, ¡entré en pánico! Me puse a trabajar y no sabía qué hacer ni por dónde empezar. Las tareas seguían llegando y acumulándose mientras intentaba descubrir cómo abordarlas.

Al final todo salió bien. Pude entender y seguir adelante. Pero a partir de ese día, supe que debía contar con la documentación necesaria para cualquier licencia o movimiento del equipo, como ascensos o…