Cómo escribir un Documento de Diseño de Software

Un documento de diseño de software es el "cómo" de la documentación del ciclo de vida del software. En él se detalla cómo se deben implementar los requisitos de software y le da a los programadores un modelo a seguir.

El documento de diseño de software es un contrato escrito entre usted, su equipo, su jefe de proyecto y su cliente. Al documentar sus supuestos, las decisiones y los riesgos, que da a los miembros del equipo y las partes interesadas la oportunidad de aceptar o pedir aclaraciones y modificaciones. Una vez que el documento de diseño de software es aprobado por las partes apropiadas, se convierte en un punto de referencia para limitar los cambios en el alcance del proyecto.

Instrucciones

1 Investigar el documento de formato / plantilla utilizada en el documento de requisitos de software. Esto incluye la página del título, el formato de numeración de páginas, números de sección y el historial de revisiones. Utilice el mismo o similar formato de documento para el documento de diseño de software.

2 Incorporar algunos, si no todos, de los siguientes elementos:

resumen de alto nivel

Las definiciones de los símbolos, formas, acrónimos y términos singulares no estándar en el documento

¿Cómo se logrará cada requerimiento

supuestos

restricciones

Software de análisis de riesgos

procedimientos de desarrollo y directrices de codificación

lenguajes y herramientas estándar

Las definiciones de las variables y una descripción del lugar en que se utilizan

Estructura lógica y pasos de procesamiento lógicas

Error, alarma y mensajes de advertencia

Medidas de seguridad

Actuación

fiabilidad

3 Considere la forma de estructurar el documento de diseño. Esto es especialmente importante cuando se está diseñando un sistema grande y complejo. Romper el sistema en partes lógicas y utilizar estas partes como los encabezados de sección en el documento de diseño de software. Si el sistema es muy grande, crear múltiples documentos de diseño, cada uno relativo a una parte particular del sistema.

4 Dé a cada elemento de diseño de un identificador único. Esto permitirá que se remonta a la exigencia de aplicación y, finalmente, a la prueba aplicable.

5 Incluye suficientes detalles para los programadores, al tiempo que incorpora algunos resúmenes de alto nivel para los gerentes.

6 Desarrollar prototipos. Si puede incluir algunas capturas de pantalla o código de ejemplo en el documento de diseño, esto ayudará a transmitir su intención de diseño. prototipos en desarrollo también deben reducir el tiempo que se gastará codificación.