Capítulo 9. Documentación Documentación
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
La documentación es un aspecto de la ciencia de datos que a menudo se pasa por alto. Suele dejarse para el final de un proyecto, pero entonces te entusiasma pasar a un nuevo proyecto, y la documentación se apresura o se omite por completo. Sin embargo, como comenté en "Legibilidad", la documentación es una parte crucial para que tu código sea reproducible. Si quieres que otras personas utilicen tu código, o si quieres volver a él en el futuro, necesita una buena documentación. Es imposible recordar todos tus pensamientos de cuando escribiste originalmente el código o realizaste inicialmente los experimentos, por lo que es necesario registrarlos.
Una buena documentación comunica bien las ideas. Tu lector tiene que entender lo que tú quieres que entienda. Así que, en primer lugar, es importante considerar para quién estás escribiendo la documentación. ¿Estás registrando tus experimentos para otro científico de datos que pueda hacerse cargo de tu proyecto en el futuro? ¿Estás documentando un fragmento de código que crees que puede ser útil para otras personas de tu equipo? ¿O estás registrando tus propios pensamientos para poder volver a ellos dentro de seis meses? Elige tu nivel de detalle y el lenguaje que utilizas para que sea apropiado para el lector que esperas.
Otros aspectos de una buena documentación incluyen estar al ...
Get Ingeniería de Software para Científicos de Datos now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
