Guía de Estilo para la Documentación del Proyectox - EPI Gijón ...

UNIVERSIDAD DE OVIEDO
Escuela Politécnica de Ingeniería de Gijón
Ha de indicar detalladamente la especificación del sistema, es decir, lo que se quiere que
haga el sistema (no cómo), junto con la información que éste ha de almacenar y las
interfaces con otros sistemas, sean hardware o software, y otros requisitos (rendimiento,
seguridad, etc.). En el caso de que exista un pliego de condiciones de contratación, este
se incluirá como documento separado.
Se incluirán posibles restricciones relativas al entorno de implantación, en el caso de
que existan. Se incluirán, asimismo, la planificación de las pruebas de aceptación del
sistema, en el caso de que sean requeridas.
Preferiblemente se utilizarán metodologías reconocidas y actuales de desarrollo de
software (Métrica Versión 2 para Sistemas de Información, Metodologías para Sistemas
en Tiempo Real, Orientadas a Objetos, etc.), especialmente utilizando representaciones
gráficas.
Diseño
El objetivo del diseño es determinar cómo se ha de realizar el sistema, la división de
éste en diferentes componentes y la comunicación entre ellos. Asimismo, se determinará
el equipamiento hardware y software necesario, justificando su elección, en el caso de
que esto no haya sido un requisito previo.
Se ha de llegar a un nivel suficiente de detalle que permita comprender la totalidad de la
estructura del producto desarrollado, utilizando en lo posible representaciones gráficas.
Manuales Técnicos
En función del tipo de proyecto y metodología empleada, el contenido se podrá
desglosar en varios documentos. En todo caso, en ellos se ha de incluir toda la
información necesaria para aquellas personas que se han de encargar del desarrollo y/o
modificación del sistema:
1. Recursos necesarios: Herramientas necesarias y conocimientos necesarios de los
recursos humanos.
2. Operaciones necesarias para la modificación y prueba del software (integración,
generación del sistema, herramientas de prueba, especificaciones y resultados de
los casos de pruebas, etc.).
3. Posibles problemas y soluciones
En este documento es donde se incluirán los listados fuente de los programas
desarrollados en forma de apéndices, los cuales, en función de su tamaño podrán ser
encuadernados en un volumen aparte.
Manuales de Usuario
Han de incluir toda la información necesaria para aquellas personas que utilicen el
sistema:
6