Itqualityassurance
- Por qué es importante producir documentación que sea fácil de usar?
- ¿Cuáles son las diferencias entre la documentación del usuario y la documentación del sistema? ¿Cuál es su utilidad??
- ¿Qué debe incluirse en la documentación del usuario??
Por qué es importante producir documentación que sea fácil de usar?
El lenguaje y el contenido fácil de usar en el documento contribuyen a la capacidad del usuario para comprender la información presentada y aplicar esa información según lo previsto.
¿Cuáles son las diferencias entre la documentación del usuario y la documentación del sistema? ¿Cuál es su utilidad??
La documentación del sistema representa documentos que describen el sistema en sí y sus partes. Incluye documentos de requisitos, decisiones de diseño, descripciones de arquitectura, código fuente del programa y preguntas frecuentes. La documentación del usuario cubre manuales que están preparados principalmente para usuarios finales de los administradores de productos y sistemas.
¿Qué debe incluirse en la documentación del usuario??
La excelente documentación del usuario debe incluir: lenguaje sencillo, simplicidad, imágenes, un enfoque en el problema, una jerarquía y flujo lógico, una tabla de contenido, contenido de búsqueda, contenido accesible, buen diseño, comentarios de usuarios reales y enlaces a recursos adicionales.
