Diseño de la documentación
La documentación se encuentra estructurada en 4 secciones
| Tutoriales | Guias | Explicaciones | Referencia | |
|---|---|---|---|---|
| Orientado a | Aprender | Cumplir un objetivo | Entender | Informar |
| Debe | Permitir empezar a un principiante | Enseñar como solucionar un problema concreto | Explicar | Describir el software |
| Escrito como | Una leccion | Una serie de pasos | Un Razonamiento | Al grano |
Esta estructura para trabajar con la documentación ayuda tanto a los autores como lectores a saber: - El tipo de material que hay en una sección - Como debe estar escrita una sección - Que debe haber escrito en una sección - En que sección debe estar escrito
Una vez entendida esta estructura, es muy sencillo donde hay que cambiar o mejorar la documentación
Este sistema está basado en el modelo de creación de documentación por Daniele procida, más información aquí