Skip to content

Commit ae563dd

Browse files
committed
avance: en apunte sobre documentacion
1 parent 2feeab1 commit ae563dd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

apuntes_en_desarrollo/Documentacion.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Documentación
22
00_00_2024
33

4-
La documentación de los proyectos es importante, nos permite dejar clara toda la información que un desarrollador podría necesitar en el futuro, podriamos ser nosotros mismos o un equipo completamente nuevo. Hay dos tipos principales de documentacion, la del código y la del equipo, en ambas buscamos aportar información que no es obia y explicar cual es proposito de cada cosas dentro del proyecto.
4+
La documentación de los proyectos es importante, nos permite dejar clara toda la información que un desarrollador podría necesitar en el futuro, podriamos ser nosotros mismos o un equipo completamente nuevo. Hay dos tipos principales de documentacion, la del código y la del equipo, en ambas buscamos aportar información que no es obia y explicar cual es proposito de cada cosa dentro del proyecto.
55

66
Documentación del código:
77

@@ -74,7 +74,7 @@ Algunos consejos para mantener la documentación actualizada son:
7474

7575
## Documentación del equipo y proyecto
7676

77-
Hay muchas formas de documentar un proyecto y las practicas del equipo, la mas simple es usando documentos Markdown y lo que vamos a documentar es:
77+
Hay muchas formas de documentar un proyecto y las practicas del equipo, la mas simple es usando documentos Markdown, pero sea cúal sea el medio que elijamos la documentación debe ser facilmente accecible para todo el equipo. Lo que vamos a documentar es:
7878

7979
* La arquitectura de la aplicación.
8080

@@ -86,5 +86,5 @@ Hay muchas formas de documentar un proyecto y las practicas del equipo, la mas s
8686

8787
* Los casos de uso e historias de usuario.
8888

89-
En este tipo de documentacion es recomendable agregar diagramas si ayudan a entender el funcionamiento de la aplicación.
89+
En este tipo de documentacion es recomendable agregar diagramas si estos ayudan a entender el funcionamiento de la aplicación, no sirve de nada hacer diagramas que nadie entiende. El diagrama mas recomentable para documentar podría ser el C4.
9090

0 commit comments

Comments
 (0)