|
Dirigida a desarrolladores y personal técnico que trabaja con el código.
| Tipo |
Descripción |
Contenido Principal |
| Documentación de Código |
Comentarios y anotaciones en el código fuente |
Propósito de funciones, parámetros, lógica |
| Documentación de API |
Especificación de interfaces y endpoints |
Endpoints, métodos, parámetros, respuestas |
| Documentación de Arquitectura |
Diseño de alto nivel del sistema |
Diagramas, patrones, componentes, decisiones |
| Guía de Desarrollo |
Instrucciones para desarrolladores |
Setup, convenciones, workflow, contribución |
| README |
Punto de entrada al proyecto |
Descripción, instalación, uso básico, licencia |
Dirigida a usuarios finales que utilizarán el software.
|
Guía completa sobre cómo usar el software.
• Instrucciones paso a paso
• Capturas de pantalla
• Casos de uso comunes
• Solución de problemas
|
Introducción rápida para comenzar a usar el software.
• Instalación básica
• Primeros pasos
• Configuración inicial
• Características principales
|
|
Respuestas a preguntas comunes de usuarios.
• Dudas frecuentes
• Problemas comunes
• Tips y trucos
• Mejores prácticas
|
Lecciones prácticas para aprender funcionalidades.
• Ejercicios prácticos
• Videos demostrativos
• Ejemplos interactivos
• Proyectos de ejemplo
|
|