La definición de documentación es la siguiente:
1. La documentación es una descripción escrita de un sistema de software.
2. La documentación debe describir con precisión el sistema de software.
3. La documentación del software es una forma de comunicación entre ingenieros de software.
4. Hay muchos tipos de documentos, incluidos documentos de requisitos de software, documentos de diseño, documentos de prueba, manuales de usuario, etc.
5. Hay muchas formas de presentar documentos, que pueden ser en forma de texto escrito tradicional o gráficos, o en forma de páginas web dinámicas.
¿Documento?
Pinyin: [wén dàng]
Un soporte de datos y los datos registrados en él. Es permanente y puede ser leído por humanos o máquinas. Los ejemplos de ingeniería de software incluyen planes de proyecto, especificaciones, planes de prueba y manuales de usuario. ?
——Citado de DL/T1142-2009 "Pruebas de software del sistema de control de reactores de plantas de energía nuclear"
La documentación es información esencial en el desarrollo, uso y mantenimiento de software.
La documentación de software o documentación de código fuente se refiere a entidades de texto relacionadas con sistemas de software y sus procesos de ingeniería de software. Los tipos de documentos incluyen documentos de requisitos de software, documentos de diseño, documentos de prueba, manuales de usuario, etc.
Los documentos de requisitos, documentos de diseño y documentos de prueba generalmente son escritos por desarrolladores durante el proceso de desarrollo de software, mientras que los documentos que no son de proceso, como los manuales de usuario, son escritos por escritores no técnicos especializados.
Los documentos pueden mejorar la eficiencia del desarrollo de software, garantizar la calidad del software y desempeñar un papel de orientación, ayuda y resolución de dudas durante el uso del software. Especialmente en los trabajos de mantenimiento, los documentos son información indispensable. .