Clasificación de documentos de desarrollo de software.
1. Los "requisitos funcionales": derivados de los requisitos del cliente y la investigación de mercado, son el primer eslabón en el desarrollo de software. El cliente propone un concepto funcional vago, pide resolver un problema práctico o hace referencia a una función de un software similar. Los clientes con experiencia en software también proporcionarán especificaciones técnicas más detalladas, anotarán la lista completa de sus requisitos en el documento y la explicarán con diagramas cuando sea necesario. Este documento es la base para el análisis de requisitos.
2. "Plan de oferta": según los requisitos funcionales del usuario, después de comunicarse y confirmar con la parte ofertante, el personal técnico comienza a redactar el "Plan de oferta". El plan generalmente incluye lo siguiente importante. Capítulos: Prefacio: antecedentes del proyecto, antecedentes y negocios de la empresa, estructura del personal técnico, introducción del caso exitoso de la empresa, etc. Análisis de requisitos: requisitos del proyecto, estructura del software, lista de funciones, descripción de funciones, precauciones, etc. Soluciones técnicas: requisitos generales e ideología rectora, soluciones técnicas, plataforma de desarrollo de software, sistema de estructura de red, etc. Gestión de proyectos: describe el proceso de desarrollo de software de la empresa, los servicios de implementación de ingeniería, la organización y división del trabajo del personal, el control del progreso del desarrollo, la garantía de calidad del software, la aceptación de proyectos y la capacitación del personal, la documentación del software, etc. Soporte técnico: soporte técnico de la empresa e introducción del servicio, objetivos y metas del servicio, niveles de servicio y tiempos de respuesta, áreas de servicio técnico, períodos de servicio técnico, contactos de usuarios autorizados, etc. Cotización del sistema: lista de cotizaciones de plataformas de software y hardware, costos de desarrollo de software, costos de mantenimiento del sistema, etc. Progreso del proyecto: el plan de progreso de todo el proyecto, incluida la planificación del tiempo para la firma del contrato, el inicio del proyecto, el análisis de requisitos, el análisis del sistema, el desarrollo del programa, el mantenimiento de pruebas, la integración del sistema, la aceptación del usuario, la capacitación del usuario y otros pasos.
3. "Análisis de requisitos": incluye descripción general del producto, conceptos principales, procedimientos operativos, lista de funciones y explicación, precauciones, entorno del sistema, etc. Con base en los "Requisitos funcionales", realice un análisis funcional detallado (incluidos los requisitos propuestos por los clientes y las funciones sugeridas según la experiencia de desarrollo) y enumere qué es este producto, qué conceptos especiales tiene, qué categorías funcionales incluye y qué funciones que debe tener, cómo operar esta función, a qué detalles se debe prestar atención al implementarla, cuáles son los requisitos del cliente, los requisitos del entorno operativo del sistema, etc. La descripción de la función aquí es consistente con el manual de usuario posterior.
4. "Análisis técnico": incluye selección de tecnología, comparación de tecnología, desarrolladores, soluciones a problemas técnicos clave, riesgos tecnológicos, dirección de actualización de tecnología, evaluación de soluciones técnicas, análisis de tecnología de la competencia, etc. Con base en el "Análisis de requisitos", realice un análisis técnico detallado (rendimiento del producto y métodos de implementación), enumere qué soluciones técnicas deben usarse para este proyecto, por qué, qué problemas técnicos deben resolverse y estime qué dificultades se encontrarán. durante el período de desarrollo. ¿Cómo se actualizará la solución técnica en el futuro? ¿Cuál es su evaluación de la tecnología de este proyecto?
5. "Análisis del sistema": incluye implementación de funciones, composición de módulos, diagrama de flujo funcional, interfaz de funciones, diccionario de datos, diversas cuestiones que deben considerarse en el desarrollo de software, etc. Con base en el "Análisis de requisitos", se realiza un análisis detallado del sistema (métodos de implementación y desarrollo del producto) para estimar qué problemas deben aclararse durante el período de desarrollo. Con base en el "Análisis del sistema", el programador comienza a codificar bajo el liderazgo de. el supervisor del proyecto.
6. "Documento de base de datos": incluye el nombre de la base de datos, el nombre de la tabla, el nombre del campo, el tipo de campo, la descripción del campo, las observaciones, la fórmula de cálculo del valor del campo, etc. Basado en el "Análisis del sistema", realice un diseño detallado de la base de datos. Se pueden utilizar diagramas para explicar cuando sea necesario, especialmente para bases de datos relacionales.
7. "Documento de función de función": incluye nombre de variable, valor inicial de variable, función, nombre de función, parámetros, cómo llamar, comentarios, precauciones, etc. Basado en el "Análisis del sistema", proporcione una explicación detallada y enumere cuántas funciones están involucradas en cada función, para que los programadores puedan modificarla, asumirla y expandirla en el futuro.
8. "Documento de interfaz": incluidos los requisitos de apariencia del software, materiales de la interfaz, herramientas de edición, nombres de archivos, menús, botones y otros componentes de la interfaz. Esto es consistente con la interfaz en ejecución una vez completado el software. .
9. "Manual de compilación": incluye el entorno de compilación del servidor, el sistema operativo, las herramientas de compilación, la información de la versión del compilador GNU C, la descripción del directorio, la generación del programa, la lista de archivos del programa fuente, la configuración de Makefile y una lista relacionada. correspondencias del programa. El proceso de compilación del cliente, los resultados de la compilación, los ejemplos de compilación, el entorno de compilación, el sistema operativo, las herramientas de compilación, la lista de archivos fuente y el proceso de creación del programa de instalación.
10. "Documento de control de calidad", que incluye la introducción del producto, los principios del producto, la lista de funciones del producto, la descripción de la función, el proceso de la función, los resultados de la ejecución, la estructura de la base de datos, los requisitos de prueba, etc., proporcionados a los probadores de software.
11. "Resumen del proyecto": incluye la introducción del proyecto, los participantes del proyecto y el tiempo de desarrollo, el proceso de gestión de riesgos del proyecto, la lista de funciones del proyecto, las características de la estructura del proyecto, las características técnicas, las sugerencias de actualización para el proyecto y los planes futuros. sugerencias, calidad del personal, etc. 1. "Introducción del producto": incluye antecedentes de la empresa, concepto del producto, ámbito de aplicación, funciones del producto, características funcionales, requisitos operativos y dirección de contacto de la empresa.
2. "Demostración del producto": incluye perfil de la empresa, antecedentes del producto, descripción del producto, características del producto, funciones del producto, ámbito de aplicación, análisis de uso, módulos funcionales, resolución de problemas, socios, casos exitosos, etc. . Esto generalmente se logra utilizando un software de grabación de Power Point o VCD.
3. "Preguntas y respuestas": enumera los problemas que preocupan a los usuarios y cómo solucionarlos. Se utiliza para responder preguntas sobre las funciones operativas del software y resolver problemas de los usuarios.
4. "Introducción de funciones": basado en el "Análisis de requisitos", incluye la introducción del software, la estructura del software, la lista de funciones, la descripción de las funciones y la dirección de contacto de la empresa.
5. "Libro técnico": basado en el "análisis técnico", incluye la realización de funciones, la selección de tecnología, la solución de problemas técnicos clave, las características de la solución técnica, la dirección de actualización de la tecnología, etc.
6. "Informe de evaluación": un informe de evaluación autorizado por un tercero. Incluyendo el propósito de la evaluación, el alcance de la evaluación, el entorno de la evaluación, el contenido de la evaluación, los datos de medición reales, el desempeño, el análisis de resultados y el resumen de la evaluación, etc.
7. "Manual de instalación": incluye el entorno del sistema, la plataforma operativa, el proceso de instalación del producto, la configuración del entorno inicial, los registros de instalación, etc.
8. "Manual de usuario": incluye introducción del producto, lista de funciones, descripción y explicación de las funciones, funcionamiento de las funciones, servicio al cliente e información de contacto, etc.
9. "Manual de mantenimiento": incluye introducción del producto, instrucciones del sistema, configuración inicial del entorno, configuración del sistema, gestión y copia de seguridad de datos, preguntas técnicas e información de contacto, etc.
10. "Informe de usuario": incluye la introducción del producto, el momento de la compra, el propósito de uso, el tiempo de uso, la ubicación del uso, el proceso de implementación, los problemas y las soluciones, el resumen y las sugerencias del producto, etc.
11. "Capacitación en ventas": incluida la introducción del proyecto, las funciones del producto, las características del producto, las ventajas comerciales, el entorno operativo del sistema, el alcance de la aplicación, los clientes objetivo, etc. Primero, el documento de análisis de requisitos
El documento de análisis de requisitos del usuario se refiere a registrar la información requerida por el usuario al comunicarse con el cliente, realizar un análisis de la demanda en función de los requisitos del usuario y planificar el software que queremos. desarrollar. Qué funciones se pretenden alcanzar.
Segundo documento de diseño del esquema
Diseño del esquema: Como su nombre indica, consiste en hacer un resumen general del software que queremos desarrollar y diseñar los módulos funcionales que contiene el software. A partir de ahora tendremos objetivos y dirección a la hora de desarrollarnos.
Tercero, documento de diseño del sistema
El diseño del sistema es una implementación detallada del esquema, que consiste en analizar los pequeños módulos incluidos en los principales módulos funcionales del software que queremos desarrollar. y Estos pequeños módulos se enumeran uno por uno, y luego a los desarrolladores de software se les asignan tareas de desarrollo de manera ordenada.
Cuarto documento de diseño detallado
El documento de diseño detallado expresa principalmente el procesamiento de la lógica empresarial de cada uno de nuestros pequeños módulos y pequeñas funciones en palabras, lo que permite a los programadores Hay una base y referencia. al codificar, al mismo tiempo, al diseñar documentos detallados, algunas empresas de software también elaborarán los documentos correspondientes de "Especificación de código de desarrollo de software" basados en diferentes proyectos. Garantizar la uniformidad de lo que hacemos.
Quinto, documento de prueba de software
Cuando completemos la codificación con referencia al documento de diseño de software detallado, escribiremos el documento de prueba de software de acuerdo con las funciones que más hemos implementado; pruebas Hay dos tipos de documentos, uno es el documento de prueba unitaria de software y el otro es el documento de prueba de combinación de software, como su nombre indica, prueba unitaria: es un documento que prueba cada pequeño método en el software, un método independiente; Prueba combinada: consiste en combinar varios módulos funcionales para realizar pruebas, principalmente para detectar la interactividad y la integración funcional de cada módulo funcional.
Sexto documento de informe resumido después de completar el software
No importa el tamaño del software desarrollado, después de completar el desarrollo de un software, resumiremos los problemas y proyectos en progreso. Registre el resumen de desarrollo juntos para evitar que ocurran problemas similares en el futuro y mejorar nuestra eficiencia de desarrollo.
De acuerdo con el tamaño, los estándares y las necesidades del cliente de la empresa de desarrollo de software, el tipo y la cantidad de documentos de desarrollo también son diferentes. Los documentos relacionados con el desarrollo de software que analizo aquí son los más básicos; En la industria del software hay un dicho: si un software se puede completar con éxito y si sus funciones son perfectas depende de cuántos documentos tenga. Los documentos de desarrollo de software son la columna vertebral de un software. Si sus documentos de desarrollo están llenos de lagunas, entonces. el software que desarrolle también será bueno; la calidad de la documentación de desarrollo puede afectar directamente el éxito del software desarrollado.