September 2024
Intermediate to advanced
260 pages
6h 59m
Spanish
Content preview from Ingeniería de Software para Científicos de Datos
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
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 ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.