Con el objetivo de consolidar lo aprendido acerca de documentación de software, se ha creado este repositorio como manual de referencia para futuros proyectos.

• 1. Conceptos generales

  • 1.1 ¿Qué es documentación de software?

  • 1.2 ¿Qué tipos de documentación existen?

• 2. Metadatos del documento

• 3. Estructura del documento

• 4. Documentación basada en texto

  • 4.1 Estilo del documento

  • 4.2 documentación de código

  • 4.3 documentación de buenas prácticas

  • 4.3 uso de listas

  • 4.4 uso de tablas

  • 4.5 uso de imágenes

  • 4.6 uso de enlaces

• 5. Documentación basada en diagramas

• 6. manual de procedimientos

• 7. Fases de documentación en un proyecto de software

  • 7.1 Fase de preámbulo

  • 7.2 Fase de exploración

  • 7.3 Fase de análisis de requerimientos

  • 7.4 Fase de diseño de la solución

  • 7.5 Fase de seguimiento de la implementación

  • 7.6 Fase de entrega