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

los documentos de diseño de software vienen en muchas variedades, pero casi todos comparten el objetivo común de describir las funciones de software, datos o interfaces. Los documentos de diseño van de documentos de arquitectura de alto nivel a los documentos de diseño detallado, documentos de control de interfaz y documentos de diagrama de flujo. Algunos documentos de diseño son de forma libre, mientras que otros siguen un enfoque más formal como el Unified Modeling Language (UML).

Instrucciones

1 Determinar qué nivel cubrirá su documento de diseño. Por ejemplo, si usted está haciendo un documento de control de interfaz entre el software y el otro componente del sistema o software, a continuación, se necesita un documento de diseño de bajo nivel, que incluirá detalles de la interfaz. Por otro lado, si está trabajando en un nuevo diseño, entonces es posible que necesite un documento de diseño tales como un documento de diseño arquitectónico que muestra el software a un alto nivel de abstracción.

2 Determinar qué información incluir. La información a incluir dependerá del tipo de documento de diseño que está redacción y amolar nivel de detalle que necesita. Por ejemplo, en un documento de control de interfaz, tendrá que incluir información como una descripción de los datos que se transfieren a través de la interfaz, cómo se hacen las solicitudes y cómo se responde a esas solicitudes. También puede incluir otra información, como por ejemplo cómo se responderá a la futura expansión o modificaciones y tratamiento de los errores.

3 Elaborar un esquema del documento. Una vez que sepa qué información se le incluyendo, puede redactar un esbozo del documento de diseño. El esquema le servirá como marco para la redacción del documento de diseño. Una vez que tenga su esquema completado, compruebe el contorno con el nivel de detalle y la información que decidió incluir para asegurarse de que su documento cubrirá lo que ha planificado para cubrir.

4 Añadir información sobre el diseño de su esquema. Siguiendo el esquema que ha creado en el paso anterior, completar algunos detalles del documento de diseño. En el ejemplo, el documento de control de interfaz, es posible identificar las cosas igual que los elementos de datos específicos que se intercambian en una estructura de datos en particular o el calendario de los intercambios de datos. Se debe escribir el documento de diseño a un nivel de detalle que se transmite por completo la información necesaria para entender el diseño en el nivel adecuado.

5 Actualizar su documento de diseño a medida que cambian las cosas. diseños de software normalmente evolucionan a medida que avanza el proyecto. Asegúrese de revisar el documento de diseño y mantenerlo al día con su diseño actual, de modo que cuando el proyecto se haya completado, el documento de diseño refleja con precisión el diseño completo y puede ser utilizado por otros en el futuro para las tareas de mantenimiento o modificación.

Consejos y advertencias

• En la elaboración de un documento de diseño de software tener en cuenta la finalidad del documento y cómo se va a utilizar.
• Una vez que haya terminado su documento de diseño, hacer una "comprobación de validez" de manera objetiva considerar si una persona no familiarizada con el software sería capaz de comprender la información necesaria simplemente a partir de la lectura de su documento de diseño.