Documenta el codigo para mejorarlo

Última actualización
03 May 2023
Tiempo de lectura
1 min

.

Una vez que el científico de datos finaliza el proyecto, debe realizar una tarea que la mayoría detesta: documentar el código. Principalmente, los programadores odian documentar porque prefieren escribir el código y no explicarlo. Además, para que la documentación sea buena, debe ser fácil de entender incluso para los que no son programadores profesionales.

Una buena documentación contiene tutoriales de cómo se usa el proyecto en diferentes casos. Esto significa que el usuario solo necesita leer dos o tres tutoriales para entender cómo funciona el código del proyecto internamente.

La documentación debe explicar por qué el proyecto funciona como funciona. No todos los códigos cuentan con esta parte, pero podría ser necesaria para convertir el proyecto en una fuente abierta. Así los usuarios podrán contactar con el programador sobre la información que hace falta o no es incorrecta para mejorar la documentación.

Página de inicio / Programación & Data

Profesión: Científico de Datos

Conviértete en científico de datos y aprende a construir modelos estadísticos, resolver problemas y expandir la estrategia comercial basada en algoritmos de Machine Learning y Big Data. Crea tus primeros proyectos e inicia tu carrera en uno de los mercados de mayor crecimiento.

11 meses
12x de
$ 1472,50 MXN
a meses sin intereses con tarjeta de crédito
Precio total
$ 17.670 MXN
$ 35.333 MXN
Inscríbete al curso
Comparte tu opinión
Recibir notificaciones de otros comentarios

O como invitado

Suscribiete Suscribiete Suscribiete Suscribiete Suscribiete

Más artículos relacionados

02 Oct 2024
8 min
¿Qué es DevOps?

Conoce el concepto de DevOps, cómo funciona y qué beneficios trae la cooperación de diferentes equipos IT.

02 Oct 2024
8 min
22 Oct 2023
8 min
Bill Gates: La mente maestra detrás de Microsoft

Descubre cómo la increíble visión de Bill Gates transformó la tecnología para siempre.

22 Oct 2023
8 min
21 Sep 2023
7 min
Ada Lovelace: La vida y descubrimientos de la hija de lord Byron

Descubre cómo la hija de lord Byron marcó un hito en la historia de la programación.

21 Sep 2023
7 min
21 Sep 2023
7 min
¿Qué es el internet de las cosas?

Aprende cómo funciona la tecnología IoT, dónde se usa, cuáles son sus beneficios y posibles riesgos.

21 Sep 2023
7 min
21 Sep 2023
5 min
¿Qué es un objeto en programación?

Conoce el concepto del objeto en programación y aprende a crear uno para tu programa.

21 Sep 2023
5 min
21 Sep 2023
6 min
Frameworks: Marcos de trabajo para programadores

Descubre cómo puedes facilitar el desarrollo de una aplicación usando frameworks.

21 Sep 2023
6 min