Biblioteca de documentos. ¿Cómo podría ser?
La documentación es información importante para el desarrollo, uso y mantenimiento del software. La documentación de software o la documentación del código fuente se refiere a las entidades textuales asociadas con un sistema de software y su proceso 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, los documentos de diseño y los documentos de prueba generalmente los escriben los desarrolladores durante el proceso de desarrollo de software, mientras que los documentos que no son de proceso, como los manuales de usuario, los escriben redactores no técnicos especializados.
Los documentos pueden mejorar la eficiencia del desarrollo de software, garantizar la calidad del software y desempeñar un papel para guiar, ayudar y confundir el uso del software. Especialmente en el trabajo de mantenimiento, los documentos son información indispensable.
La documentación del software inicial se refería principalmente a manuales de usuario. Según la definición de Barker, la documentación se utiliza para registrar el proceso de diseño, planificación e implementación de elementos de interfaz de un sistema de software para mejorar la usabilidad del sistema.
Forward cree que la documentación de software es una forma de comunicación entre ingenieros de software, y la información que se intercambia es principalmente sobre el sistema de software desarrollado. Por otro lado, Parnas enfatiza la autoridad de la documentación. Cree que la documentación debe proporcionar una descripción precisa del sistema de software.
Definición de documentación de software
La documentación es una descripción escrita de un sistema de software.
La documentación debe describir con precisión el sistema de software.
La documentación de software es una forma de comunicación entre ingenieros de software.
Existen muchos tipos de documentos, incluidos documentos de requisitos de software, documentos de diseño, documentos de prueba, manuales de usuario, etc.
Hay muchas formas de presentar documentos, que pueden ser en forma escrita tradicional o en forma de gráfico, o en forma de página web dinámica.
Notas de Diseño de Software: Las notas de diseño de software deben entregarse después de la fase de diseño de software. La primera mitad se completa después del diseño general y la segunda mitad se escribe después del diseño detallado. La especificación de diseño tiene un doble propósito: proporciona orientación para la programación y las pruebas y brinda asistencia a los mantenedores una vez entregado el software;
El marco y el contenido de la especificación de diseño de software son los siguientes:
1. Describa el alcance general del trabajo de diseño, incluidos los objetivos del sistema, la funcionalidad, las interfaces, etc.
2. Estructura del sistema. El diagrama de estructura del software se utiliza para ilustrar la división de módulos del sistema, describir brevemente las funciones de cada módulo y proporcionar la relación de control entre cada módulo jerárquicamente.
3. Estructura de datos y diseño de bases de datos. Diseñe la estructura de datos y la base de datos utilizada por todo el sistema, incluido el diseño de la estructura conceptual, el diseño de la estructura lógica y el diseño físico. Describa los resultados del diseño con los diagramas correspondientes.
4. Diseño de interfaces. Diseñar la interfaz hombre-máquina para explicar los comandos proporcionados al usuario y la información de retorno del sistema; diseñar la interfaz externa para explicar toda la información de la interfaz entre el sistema y el mundo exterior, incluida la interfaz entre el software y el hardware, y la interfaz; relación entre el sistema y el software de soporte.
5. Diseño del módulo. Según las funciones de cada módulo, se describe detalladamente el proceso y la estructura de datos de cada módulo.
Concepto de documento
1. En el sistema operativo, los documentos son carpetas. Puede ver la propiedad "Tipo" de mi documento en el escritorio.
2. En el software, el documento recién creado es un archivo (en términos generales, en términos informáticos, es otro nombre para el archivo. Generalmente, los archivos generados por software de edición de texto como WORD y EXCEL se denominan documentos). ).