PyCon Pittsburgh. April 15-23, 2020.

Charla: Si no está documentado, su proyecto no existe.

Presented by:

Renne Silva Gomes de Oliveira Rocha

Description

¿Cuántas veces has encontrado en PyPI una increíble biblioteca que aparentemente resuelve tu problema específico pero, cuando la introduces en tu proyecto, encuentras documentación totalmente obsoleta o incompleta? ¿O es el responsable de mantener una biblioteca bien construida con código bien organizado y probado, pero nadie la usa?

Claro, todos hemos pasado por esto, pero cometimos el mismo error con nuestros propios proyectos y dejamos la documentación para más tarde, o estamos contentos con un pequeño archivo README que contiene ejemplos simples, o peor, simplemente la ignoramos pensando que solo un código bien escrito es suficiente para que otros usen nuestro proyecto.

En esta charla hablaremos sobre la importancia de la documentación, los diversos tipos de documentación que podemos hacer y algunas herramientas disponibles en el ecosistema Python para facilitar la escritura, publicación y mantenimiento de ella.

Video

Watch on YouTube