Guía de Estilo para la Documentación del Proyecto

Transcripción

1 Guía de Estilo para la Documentación del Proyecto A continuación se presentan a modo de sugerencia una guía de estilo que puede ser empleada para confeccionar los distintos documentos del proyecto. Estructura y presentación de los textos Todos los textos (Memoria, Pliego de Condiciones, Anexos, etc.) deberán estar ordenados en capítulos divididos en apartados y subapartados y éstos en párrafos. Estarán escritos en formato A4 según norma UNE 1011, por una sola cara, con los siguientes márgenes: izquierdo, 35 mm.; derecho, 15 mm.; superior e inferior, 25 mm. El tipo de letra a utilizar, para el cuerpo del texto, será Times Roman (o similar) de mínimo 10 y máximo 12 puntos, pudiendo utilizarse otros tipos de letra y otros tamaños, para los rótulos de los capítulos, apartados y subapartados de los mismos. El interlineado mínimo será de un espacio simple y el máximo de espacio y medio. Los títulos de los capítulos se escribirán en mayúsculas (subrayadas o en negrita) y los de los apartados y los distintos subapartados en minúsculas (subrayadas o en negrita), sin que nunca se subrayen los números. Los capítulos llevarán numeración correlativa arábiga, así como apartados y subapartados dentro de cada capítulo. Capítulos, apartados y subapartados utilizarán el sistema de numeración decimal, tanto como sea necesario para su más fácil comprensión y seguimiento. Como norma general, no se numerarán los párrafos, pero si fuera preciso, se utilizarán letras minúsculas. Separaciones: Los capítulos iniciarán página. La separación entre el nombre de un apartado o subapartados numerado arábigo y la última línea del párrafo anterior será de tres veces la distancia de interlineado. La separación, entre nombres de los capítulos con mayúsculas, los nombres de los apartados y subapartados en minúsculas, y su primer párrafo, así como la separación entre párrafos, será de dos veces la distancia de interlineado. Numeración de las páginas: Todas las páginas estarán numeradas correlativamente dentro de cada documento, indicando en la esquina superior derecha el número de la página. Fórmulas, figuras, citas bibliográficas, etc.: Las fórmulas y figuras a las que, posteriormente, se hagan referencias, deberán numerarse con dígitos que permitirán identificar, como mínimo, el capítulo al que pertenece la fórmula o figura y el orden que ocupa dentro del mismo. 1

2 Cuando en el texto se haga referencia a citas bibliográficas, deberá indicarse entre paréntesis sus números, tal como se indica al final de esta frase ( ref. 3). Normas de estilo En la redacción de los diferentes textos incluidos en el proyecto se seguirán, en la medida de lo posible, los siguientes criterios: 1. Títulos directos y completos (ejemplo: Interrelación entre secciones del proceso de fabricación, en vez de: Proceso de fabricación. Interrelación entre secciones). 2. Párrafos cortos. 3. Oraciones directas y completas con el mínimo posible de oraciones intercaladas. 4. Estilo impersonal y objetivo (ejemplo: Posteriormente se estudiará, en vez de: Posteriormente estudiaremos). Presentación Los distintos documentos se presentarán de acuerdo con las siguientes normas: La portada de cada volumen seguirá el modelo correspondiente, con las naturales modificaciones según el tipo de documento a que corresponda y el número de Volumen con caracteres romanos, si hay más de uno. La primera página de cada volumen reproducirá fielmente la portada de éste, añadiendo el nombre del tutor debajo del nombre del proyectante y fecha. Aunque deberá intentarse que el Proyecto sea auto-contenido, en caso de utilizar en algún documento citas bibliográficas, se incluirá al final de dicho documento un índice bibliográfico, numerado y por autores que se consignarán en orden alfabético. PROYECTO DE INGENIERIA INDUSTRIAL A continuación se enumeran normas específicas aplicables a los proyectos de Ingeniería Industrial: Memoria La primera página de la Memoria repetirá el mismo contenido de la portada. La segunda página se titulará, en el centro y con mayúsculas, INDICE DE LA MEMORIA. La tercera y siguientes corresponderán al desarrollo del índice de cada una de las cuatro partes de la Memoria, que aparecerá desglosada en capítulos y apartados, con la misma numeración decimal que tengan en el posterior desarrollo. La página siguiente a la última del índice se titulará, en el centro y con mayúsculas, MEMORIA. Al finalizar el contenido de ésta, aparecerán, si fuera necesario, CALCULOS JUSTIFICATIVOS, PLANIFICACION Y ANEXOS. 2

3 Si se incluyen cálculos de ordenador, se reducirán al formato UNE A4. Si hay varios Anexos, aparecerán numerados en caracteres romanos y debajo, el título de cada uno de ellos. Las distintas partes de la Memoria estarán separadas por cartulinas rojas. Planos La primera página de este documento repetirá el mismo contenido de la portada. La segunda página se titulará, en el centro y con mayúsculas, INDICE DE PLANOS. La tercera y siguientes corresponderán al índice de planos, que aparecerán habitualmente distribuidos por áreas y, dentro de cada una de ellas, agrupados por especialidades y ordenados por números sucesivos. A continuación del índice aparecerá la titulación, en el centro y con mayúsculas, de un área y detrás, en bolsas de plástico, los planos de dicha área ordenados por especialidades y así se hará con todas las áreas y especialidades que intervengan en el proyecto. Los distintos grupos de Planos de cada área y especialidad aparecerán separados por cartulinas de color azul. Las letras distintivas de cada especialidad serían las siguientes: G Planos generales de proceso, diagramas, implantación, etc. C Civil, Urbanización, Infraestructura, etc. A Arquitectura. S Estructuras y cimentaciones. M Instalaciones mecánicas. E Instalaciones eléctricas. T Planos de tuberías. I Planos de instrumentación y control. V Planos varios. Según el tipo de proyecto se podrán utilizar otras letras para denominar especialidades relevantes en ese proyecto concreto, aquí no incluidas. Cada plano se identificará, primero por el número atribuido al proyecto, después por el número del área a que corresponde (si hay varias), a continuación la letra de la especialidad y finalmente el número correlativo de ese plano dentro de ella. Así, el m-12, correspondería al plano nº 12, de mecánica, en el área 02 (Servicios Auxiliares) del proyecto de Ingeniería Industrial, adjudicado en el curso , con el número de orden

4 Todos los planos tendrán tamaños normalizados, siendo aconsejable el uso del UNE A- 1 siempre que sea posible. El cajetín a utilizar se incluye dentro de los Anexos. Pliego de Condiciones: La primera página del Pliego de Condiciones repetirá el mismo contenido de la portada. La segunda página se titulará, en el centro y con mayúsculas, INDICE DEL PLIEGO DE CONDICIONES. La tercera página y siguientes corresponderán al desarrollo del índice de cada una de las cuatro partes del pliego, que aparecerán desglosadas en capítulos y apartados, con la misma numeración decimal que tengan en el desarrollo. La página siguiente a la última del índice se titulará, en el centro y con mayúsculas, PLIEGO DE CONDICIONES GENERALES y al finalizar el desarrollo de esta parte, aparecerán, en la misma forma: ESPECIFICACIONES DE MATERIALES Y EQUIPOS, ESPECIFICACIONES DE EJECUCION y PLIEGO DE CONDICIONES ECONOMICAS. Las cuatro partes del Pliego de Condiciones aparecerán separadas por cartulinas de color amarillo. Presupuesto: La primera página del Presupuesto repetirá el mismo contenido de la portada. La segunda se titulará, en el centro y con mayúsculas, INDICE DEL PRESUPUESTO. La tercera página y siguientes corresponderán al desarrollo del índice de cada una de las tres partes del Presupuesto, que aparecerán desglosadas en capítulos y apartados siguiendo la misma agrupación establecida en la Memoria por áreas y especialidades, y con numeración decimal. La página siguiente a la última del índice se titulará, en el centro y con mayúsculas, MEDICIONES y al finalizar el desarrollo de esta parte aparecerán en la misma forma, PRECIOS UNITARIOS y PRESUPUESTO. Las tres partes del Presupuesto aparecerán separadas por cartulinas de color verde. En la mayoría de los proyectos las tres partes del Presupuesto se podrán sustituir por una sola, ya que la utilización del formato incluido en los Anexos permite incluir a la vez mediciones, precios unitarios y valoración. PROYECTO DE INGENIERIA INFORMATICA El contenido de los distintos documentos a presentar puede variar de acuerdo con el tamaño y características del proyecto, así como con la utilización de diferentes metodologías de desarrollo. 4

5 La distribución en diferentes volúmenes se adaptará a los tamaños de los diferentes documentos presentados, aunque respetando el orden aquí indicado. El primero siempre ha de ser obligatoriamente la memoria. A continuación se muestra a modo orientativo, el contenido que cada uno de los distintos documentos debería contener. Memoria En este primer documento se incluirá la siguiente información: Descripción del Sistema: Una introducción al sistema desarrollado, de forma que se transmita al lector de forma sencilla una idea general sobre los objetivos y el contenido del proyecto. Descripción del producto: Desde el punto de vista de un producto software susceptible de ser comercializado. Incluirá una descripción del entorno hardware y software necesario (en qué computadoras funciona, qué software requiere, indicando versiones, etc.), así como la versión y cambios introducidos desde la anterior, en el caso de que se trate de mantenimiento. Documentos que acompañan al proyecto: Se han de indicar e identificar (de forma numérica y/o alfanumérica) cada uno de los documentos presentados, haciendo referencia al volumen donde se encuentran. Información adicional de interés: Relativa a metodologías, herramientas y otros productos cuyo conocimiento sea necesario para comprender el resto del proyecto. Esta información se ha de presentar de forma breve y concisa, haciendo referencias a las fuentes de información necesarias para profundizar en los conocimientos aquí mostrados. Planificación y Presupuesto. Ha de incluir la estimación del coste (presupuesto) y de los recursos necesarios para efectuar el desarrollo del proyecto, junto con la planificación temporal del mismo y desglose en fases y tareas. Estas estimaciones se podrán comparar con los datos reales obtenidos tras la finalización del proyecto. Se diferenciarán los costes relativos a personal de los relativos a otros gastos como instalaciones y equipos. Especificación de Requisitos 5

6 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

7 1. Instalación 2. Utilización del sistema. 3. Configuración y otras operaciones rutinarias (por ejemplo, copias de seguridad). 4. Diagnósticos y mensajes de error. Hay que hacer notar que la documentación de usuario ha de ser autocontenida, es decir, para su entendimiento el usuario final no ha de necesitar la lectura de ningún otro manual técnico. 7