¿Cómo escribir documentos de requisitos en la etapa inicial del desarrollo de software?

Cómo escribir un informe de análisis de requisitos (Especificación de requisitos de software GB856T-88)

Recientemente, se han solicitado nuevamente algunos proyectos de investigación científica en la escuela y algunos estudiantes han comenzado a Pídame información escrita sobre una pregunta de ingeniería de software. Lo resumí aproximadamente y lo escribí aquí. Este artículo implica la redacción de la parte de análisis de requisitos, que se basa principalmente en los requisitos de los documentos estándar nacionales.

En las empresas de Internet o en algunas empresas de desarrollo ágil, todos adoptan la actitud de centrarse en el desarrollo, la discusión y la documentación. Esta documentación liviana no significa que no haya documentación o casi no haya documentación, sino que se libera del estricto proceso de documentación y solo escribe las partes más prácticas. Esta característica está determinada por el corto ciclo de iteración de Internet y el rápido lanzamiento de versiones. Cuando se trata de proyectos reales a tiempo parcial, los estudiantes deben prestar atención. Lo más importante debe ser adjuntar el análisis de necesidades más claro al firmar el contrato, aunque esta declaración de necesidades puede no coincidir con algunos documentos estándar. Descripción clara del efecto logrado por cada función, y este efecto debe hacer que los clientes asientan con la cabeza para confirmar, en lugar de respuestas vagas como "debería ser", "puede ser" y "tal vez". De lo contrario, será más difícil más adelante en el proyecto. En los proyectos solicitados por escuelas y en el desarrollo de proyectos de grandes empresas, el proceso documental se toma en serio, paso a paso. Por lo tanto, es mejor tratar la profundidad y el estándar del documento según la situación.

1. Tabla de contenido: la tabla de contenido debe usar "Referencia" -> "Tabla de contenido" de Word para generar automáticamente una tabla de contenido, que generalmente requiere una tabla de contenido de tercer nivel. Por lo general, básicamente no es necesario cambiar la estructura de esta parte, simplemente actualice los números de página directamente.

2. Parte del contenido. Especificación de requisitos de software estándar nacional G856T-88 Descargar

1 Introducción

1.1 Propósito de la escritura

Describa el propósito de escribir esta especificación de requisitos de software e indique los lectores previstos .

(Esta parte describe la descripción general del informe de análisis de requisitos, por ejemplo: Este informe de análisis de requisitos X está escrito para el sistema S. + Una descripción general de dos oraciones del sistema S. + Este informe X es La intención es hacer que U1 (demandantes) aclare los requisitos y detalles del sistema S, dejar que U2 (desarrolladores) comprenda la dificultad y la dificultad de cumplir los requisitos, y finalmente proporcionárselos a U3 (revisores, gerentes) para su discusión y revisión para lograr la comunicación. efectos)

1.2 Antecedentes

Instrucciones:

a. El nombre del sistema de software a desarrollar;

b. El proponente de la tarea, desarrollador, usuario de este proyecto y el centro de cómputo o red informática que implementa el software;

c. La interrelación básica entre el sistema de software y otros sistemas u otras organizaciones.

(Esta parte se puede dividir en dos partes a, b y c. El ejemplo es el siguiente:

1.2.1 Descripción general del proyecto

¿Qué es? Lo esperado en este informe de análisis de demanda. El sistema de software desarrollado es: S. S es un determinado submódulo funcional del sistema SS, la relación entre S y S1, S2 y otros sistemas, así como una descripción general del estado de otros sistemas. , etc.

1.2.2 Asignación de tareas

a Proponente de tareas: xxx

b Desarrollador de software: xx

c. Usuario del producto: xx

d. Redactor del documento: xx

e. Usuarios previstos del producto: xx

)

1.3 Definición

Enumere las definiciones de los términos técnicos utilizados en este documento y las frases originales de las siglas extranjeras.

(Esta parte es muy simple, es para describir vocabulario profesional, como

1. Lenguaje de marcado universal

2.Palabra2, explicación.

1.4 Referencias

Materiales de referencia, tales como:

a. La declaración de misión aprobada o contrato de este proyecto, y el documento de aprobación de la autoridad superior;

b. Otros documentos publicados pertenecientes a este proyecto;

c. Los documentos y materiales citados a lo largo de este documento incluyen los estándares de desarrollo de software que se utilizarán.

Indique el título, número de documento, fecha de publicación y unidad de publicación de estos documentos e información, e indique la fuente de donde se pueden obtener estos documentos e información.

2 Descripción general de la tarea

2.1 Objetivos

Describir la intención, los objetivos de la aplicación, el alcance del desarrollo de software y otra información sobre el desarrollo de software que se debe explicar a material de referencia de los lectores. Explicar la relación entre el software que se está desarrollando y otro software relacionado. Esto se indica si el Producto de software es un software independiente y es completamente autónomo. Si el producto definido es un componente de un sistema más grande, se debe describir la relación entre el producto y otros componentes del sistema. Para este propósito, se puede utilizar un diagrama de bloques para ilustrar los componentes del sistema y el producto. interfaces con otras partes. |

(

El desarrollo de este módulo es principalmente para servir el servicio general de SS y completar la parte XX del trabajo de SS y trabajos relacionados. Su alcance es desde la emisión A hasta la B Después del comando, vaya al proceso de dar el resultado C. Descripción específica: B1, para completar la función B11; B2, para completar la función B22, etc. Esta parte (no) está acoplada a otras partes del kit de herramientas de segmentación de palabras; , principalmente para incrustar. Los modos y los modos secuenciales interactúan entre sí

Figura

Figura 1. La relación y la interfaz entre los componentes del sistema y otras partes

)

2.2 Características de los usuarios

Enumere las características de los usuarios finales de este software, describa completamente el nivel de educación y experiencia técnica de los operadores y el personal de mantenimiento, y la frecuencia esperada de uso de este software. Estas son limitaciones importantes para el trabajo de diseño de software

(Por ejemplo: desarrollo secundario y personal de llamadas al sistema: tener un alto nivel de conocimiento profesional y comprender el mecanismo operativo de XX. Puede leer y analizar códigos abiertos para cumplir las necesidades únicas del sistema, abra el manual de API y el código fuente de la versión de depuración para estos usuarios, se espera que estos usuarios representen una gran proporción del total de usuarios de este sistema. Usuarios de xx: tienen ciertas capacidades y conocimientos de operación de computadoras, y comprenden los conceptos y usos relevantes en el campo de xx. Se espera que estos usuarios realicen principalmente operaciones de xx simples: tienen un alto nivel de experiencia en computadoras, pueden rastrear y analizar los comunes. errores del sistema y tienen ciertas capacidades de prueba. Estos usuarios son principalmente mantenedores posteriores al trabajo después de adoptar este sistema

etc.

)

2.3 Supuestos. y restricciones

Enumere los supuestos y restricciones para el desarrollo de este software, como restricciones de financiación, plazos de desarrollo, etc.

(Esta parte se basa principalmente en suposiciones sobre su solidez técnica, situación financiera, recursos humanos, etc., para que pueda completar el trabajo en qué circunstancias y plazos. Limitaciones de tiempo de construcción, limitaciones financieras, se enumeran y explican las limitaciones de personal, las limitaciones geográficas, las limitaciones de equipo y otros aspectos)

3 Requisitos

3.1 Requisitos funcionales

Utilice una lista (por ejemplo, una tabla IPO tiene la forma de una tabla de entrada, procesamiento y salida). Describir los requisitos funcionales para el software elemento por elemento, cuantitativa y cualitativamente, explicar qué cantidad se ingresa, cómo se procesa, qué salida se obtiene y qué terminales debe admitir el software y la cantidad de usuarios que operan en paralelo que deben admitirse.

(Por ejemplo:

ENTRADA entrada

PROCESO procesamiento

SALIDA salida

CARGA carga

A

Preprocesamiento, qué acciones hacer,

AA

CC

B

BBBB

Sib

v

C

CCCC

cc

v

Tabla 1, tabla IPO del módulo xx

Una breve descripción textual de la tabla IPO

)

3.2 Requisitos de rendimiento< /p. >

3.2.1 Precisión

Explique los requisitos de precisión para los datos de entrada y salida del software, que pueden incluir precisión durante el proceso de transmisión.

(Por ejemplo:

Procesamiento de destino Xx: 1Byt_10M, incluidos los valores de límite izquierdo y derecho.

Rango de precisión de Yy: .

Precisión de ZZ: debido a la particularidad de xx, este sistema utiliza el tipo xx para realizar operaciones estadísticas de caracteres, y la parte de probabilidad y otras partes de proporción son precisas. a 0,0x%.

)

3.2.2 Requisitos de características de tiempo

Explique los requisitos de características de tiempo para el software, tales como:

a. Tiempo de respuesta;

b. Actualizar el tiempo de procesamiento;

c. Tiempo de conversión y transmisión de datos;

d. Tiempo de resolución de problemas; etc. requisitos.

(Estas partes solo deben enumerarse una por una:

Dado que el proceso xxx requiere una gran cantidad de operaciones xxxx o algo así, el tiempo de resolución de problemas xx representa la mayor cantidad parte del tiempo total es la sobrecarga de conversión y almacenamiento de xx. Los requisitos de características de tiempo específicos son los siguientes:

a. tiempo de respuesta de xx: aproximadamente xxms

b. tiempo de procesamiento de actualización: yy;

c. zz tiempo de conversión y transmisión de datos: zz

d. p>

3.2.3 Flexibilidad

Explique los requisitos para la flexibilidad del software, es decir, cuando ocurren ciertos cambios en los requisitos, la capacidad del software para adaptarse a estos cambios, como por ejemplo:

a. Cambios en los métodos operativos;

b. Cambios en el entorno operativo;

c. Cambios en las interfaces con otro software;

d. Cambios en la precisión y el período de validez;

e. Cambios o mejoras planificadas.

Deben identificarse secciones especialmente diseñadas para proporcionar esta flexibilidad.

(Esta parte se puede enumerar como una lista. Dado que el primer propósito de este módulo es usarse para xxx, seguido de xxxx. Por lo tanto, la flexibilidad de este módulo depende de la aplicación real. Cuando ciertas ocurren requisitos Cuando ocurren cambios, la capacidad del software para adaptarse a estos cambios es la siguiente:

f. Cambios en el modo de operación: se adoptan dos modos: modo de operación integrado y modo de operación independiente. la integración de este módulo, integrado en el marco principal del conjunto de herramientas de segmentación de palabras, proporciona a los usuarios un software operable con una determinada interfaz de usuario que se ejecuta de forma independiente y es un modo de trabajo que puede ejecutarse de forma independiente en segundo plano y proporcionar un modo de llamada; varios programas para mejorar su vitalidad.

g Cambios en el entorno operativo: utilice principalmente la versión compilada de la plataforma Windows para ejecutar y depurar, y cuando el tiempo lo permita, se desarrollará una versión de servidor que admita SUSELinux. simultáneamente

h. Cambios en las interfaces de otro software: Se permite la sobrecarga y redefinición de la interfaz tratando de garantizar que la interfaz no cambie, pero las reglas de nomenclatura de la interfaz estén unificadas;

i. Cambios: la precisión puede variar en 10 puntos porcentuales si es necesario; el límite de tiempo efectivo permite una gama más amplia de cambios según la situación real de la prueba. o mejoras: habrá ciertas fluctuaciones en el cronograma de trabajo. Esta parte debe negociarse con otros miembros del equipo de diseño del proyecto del kit de herramientas de segmentación de palabras. El plan inicial se puede cambiar ligeramente y los arreglos posteriores se implementarán según lo planeado. p>

Etc.

p>

)

3.3 Requisitos de entrada y salida

Explique cada tipo de datos de entrada y salida, y describa su medio y formato. , rango numérico, precisión, etc. elemento por elemento. Explique y dé ejemplos de las salidas de datos y de control del software que deben etiquetarse, incluidas descripciones de informes impresos (salida de resultados normales, salida de estado y salida anormal) e informes gráficos o de visualización.

(Esta parte puede dividir la entrada y la salida en 3.3.1 requisitos de entrada y 3.3.2 requisitos de salida. A continuación se proporciona un ejemplo de una unidad.

XXX salida

Nombre de datos: datos de salida XXX

Significado real: utilizado para XX, que representa XXXX

Tipo de datos: carácter (cadena)

Formato de datos: XX

Restricciones de datos: debido a xxx, el tamaño está dentro de xx

)

3.4 Requisitos de capacidad de gestión de datos

Describa los archivos que deben gestionarse El número de volúmenes y registros, el tamaño de tablas y archivos, y los requisitos de almacenamiento de los datos y sus componentes deben estimarse en función del crecimiento previsible.

(

Simplemente enumere de acuerdo con los requisitos reales del sistema

Nombre

Número cantidad

Tamaño

Aumentar crecimiento

Diccionario xx

xx

xxxx

Ejecutado en paralelo, su tamaño se basa en el real xx texto grande y crecimiento

)

3.5 Requisitos para la resolución de problemas

Enumere los posibles fallos de software y hardware, así como las consecuencias para cada rendimiento y el impacto del Fallos. Requisitos de procesamiento.

(Incluyendo presión de software, memoria insuficiente, daños en el hardware, etc., puede encontrar fallas comunes según Baidu).

3.6 Otros requisitos especiales

Tales Como usuario, la unidad tiene requisitos de seguridad y confidencialidad, requisitos de facilidad de uso, requisitos especiales de mantenibilidad, complementabilidad, legibilidad, confiabilidad y convertibilidad de los entornos operativos, etc.

(Por ejemplo, seguridad y confidencialidad: reemplazo de claves, etc.; expansión esperada: compatibilidad de extensiones, etc.; reemplazo de SO: Slackware a SUSE, etc.

)

4 Requisitos del entorno operativo

4.1 Equipo

Enumere el equipo de hardware necesario para ejecutar el software. Describa el nuevo equipo y sus funciones especializadas, incluyendo:

a. Modelo de procesador y capacidad de memoria;

b. Capacidad de almacenamiento externo, en línea o fuera de línea, soporte y su formato de almacenamiento, modelo y cantidad de equipo;

c. Modelo y cantidad de dispositivos de entrada y salida, en línea o fuera de línea;

d. Modelo y cantidad de equipos de comunicación de datos;

e. Teclas de función y otro hardware especial

(Solo indique la descripción)

4.2 Software de soporte

Enumere el software de soporte, incluido el sistema operativo y el compilador que se utilizarán (o ensamblados), software de soporte de pruebas, etc.

(Sistema operativo y versión: xxxx

Entorno y versión de soporte: xxxx

Entorno y versión IDE alternativos: xxxx

Con este Componentes de software relacionados con el software: xxxx

Posible entorno de expansión posterior: xxxx

)

Interfaz 4.3

Indica que el software es el igual que otras interfaces de software, protocolos de comunicación de datos, etc.

(Por ejemplo:

a. El usuario y el programa principal llaman a la interfaz (interfaz 1 en la figura). Esta interfaz adopta la forma de API encapsulada y llamada de función, con llamadas externas y llamadas internas respectivamente. El método proporciona a diferentes usuarios acceso a esta herramienta mecánica de segmentación de palabras. Por ejemplo, el archivo DLL se llama en modo xxxx y la función se llama en modo xxxx, como se muestra en la Figura 2 a continuación. /p>

Figura 2. Diagrama de llamada de la interfaz del software

Interfaz b.xx (interfaz 2 en la figura. Aquí está el proceso de llamada de la interfaz de xxx

)

4.4 Control

Describe los métodos y señales de control que controlan el funcionamiento del software y explica las fuentes de estas señales de control.

(Por ejemplo:

El siguiente es un diagrama de los métodos operativos, señales de control y fuentes de estas señales de control de este módulo y los módulos de software involucrados en este módulo. flechas La señal de control del módulo correspondiente a la dirección señalada proviene del módulo en la otra dirección de la flecha. La situación específica es la siguiente:

Figura 3. Diagrama de flujo de control

La descripción específica de la Figura 3 es la siguiente: Pantalla:

Nombre del módulo

Modo de ejecución del método

Señal de control de señal

Dirección de control de avance

Módulo de programa principal

Ejecutar marco

Llamada de usuario o ejecución

Llamar módulo xx

2. Llamar al método xx

3. Llamar al módulo de salida estándar

módulo xxx

xxx

llamada xxx

Módulo xxx

)

Apéndice: Estándar nacional para documentos de diseño de software (GB8567_88) Estándar nacional para documentos de diseño de software (GB8567_88) Manual de operación de GB8567-88 (GB8567-88 ).doc Instrucciones de diseño de base de datos (GB8567-88) .doc informe de análisis de prueba (GB8567-88).doc especificación de requisitos de datos (GB856T-88).doc plan de prueba (GB8567-88).doc Figura 1.doc especificación de diseño del esquema ( Archivo GB8567-88).doc Ejemplos de disposiciones de implementación del sistema de subsidios (GB8567-88).doc informe mensual de progreso de desarrollo (GB8567-88).doc instrucciones detalladas de diseño (GB8567-88).doc informe del estudio de viabilidad (GB8567-88) ).doc plan de desarrollo del proyecto (GB856T——88).doc expediente de desarrollo del módulo (GB8567——88).doc informe resumido de desarrollo del proyecto (GB8567——88).doc especificación de requisitos de software (GB856T——88).doc manual de usuario (GB8567——88 ).doc