Lección 2
Documento nº 1: Memoria
+ Objeto y definición
+ Contenidos
- Tabla 1. Proyectos de Instalaciones y Equipos
- Tabla 2. Proyectos de Construcción Industrial
- Tabla 3. Proyectos de Desarrollo de Prototipos
- Tabla 4.Proyectos de Investigación
- Tabla 5.Proyectos de Productos de Software
+ Normas generales de presentación
- Normas de estilo
- Formatos
- Organización del texto
- Figuras
- Tablas
- Ecuaciones o fórmulas
- Citas bibliográficas
- Acrónimos o abreviaturas
+ Estructura básica del documento
- Índice de la Memoria
- Memoria descriptiva
- Cálculos justificativos
+ Planificación
+ Anexos
2.1. Objeto y definición
La Memoria es uno de los documentos básicos que constituyen el TF y es el nexo de unión entre todos ellos. A lo largo de la Memoria se hará referencia a cualquier documento de que conste el proyecto.
La Memoria tiene como misión justificar las soluciones adoptadas. Conjuntamente con los Planos y Pliego de Condiciones, debe describir de forma inequívoca el objeto del TF.
La Memoria tiene que estar presentada de una forma organizada y perfectamente definida. Deberá ser claramente comprensible y legible, no sólo por los profesionales especialistas sino por terceros, en particular por el cliente especialmente en lo que se refiere a:
- Los objetivos del proyecto.
- Las alternativas estudiadas.
- Sus ventajas e inconvenientes.
- Las razones que llevaron a la solución elegida.
Como puede que el cliente no sea un especialista en la materia, la Memoria debe de estar muy bien explicada y debe de ser fácil de comprender.
2.2. Contenidos específicos
En este apartado se muestran ejemplos típicos de la estructura de la Memoria Descriptiva para distintos tipos de TF. Estas estructuras no son exhaustivas, pudiendo no adaptarse a todos los TF de cada tipo en su totalidad, aunque sí se recogen los tipos de proyecto más habituales.
Para comenzar, se sugiere preparar un índice e ir completándolo según se vaya avanzando con el proyecto. De alguna forma ese índice se convierte en el esqueleto del documento que se irá rellenando poco a poco.
Se presentan las estructuras de los siguientes tipos de proyectos:
- Instalaciones y equipos,
- Construcción Industrial,
- Desarrollo de prototipos,
- Investigación, y
- Productos de software.
En las tablas que siguen se incluyen tanto los documentos de los que debe constar el TF como un índice orientativo de la memoria que constituye el documento básico del citado TF.
Tabla 2.2.1.Proyectos de Instalaciones y Equipos
PROYECTOS DE INSTALACIONES Y EQUIPOS | |
Estructura del PROYECTO | |
DOCUMENTO Nº1: MEMORIA
| |
DOCUMENTO Nº2: PLANOS | |
DOCUMENTO Nº3: PLIEGO DE CONDICIONES | |
DOCUMENTO Nº4: PRESUPUESTO | |
Estructura de la MEMORIA DESCRIPTIVA | |
1. Planteamiento y objeto del proyecto | |
2. Datos de partida | |
3. Estudios previos (si proceden) | |
4. Estudio de posibles alternativas | |
5. Ingeniería básica y de detalle
| |
6. Informes especiales (dependiendo de su naturaleza, pueden ir en los anexos y, si tienen entidad propia, incluso pueden constituir un documento). | |
7. Estudio de viabilidad económica | |
Tabla 2.2.2.Proyectos de Construcción Industrial
PROYECTOS DE CONSTRUCCIÓN INDUSTRIAL | |
Estructura del PROYECTO | |
DOCUMENTO Nº1: MEMORIA
| |
DOCUMENTO Nº2: PLANOS | |
DOCUMENTO Nº3: PLIEGO DE CONDICIONES | |
DOCUMENTO Nº4: PRESUPUESTO | |
Estructura de la MEMORIA DESCRIPTIVA | |
1. Planteamiento y objeto del proyecto | |
2. Datos de partida | |
3. Antecedentes | |
4. Estudios previos | |
5. Diseño (estudio de alternativas) | |
6. Predimensionamiento | |
7. Cálculo
| |
8. Bibliografía | |
Posibles ANEXOS de la Memoria | |
Procesos, materiales o instalaciones especiales | |
Listados de cálculo | |
Otra información de interés | |
Tabla 2.2.3.Proyectos de Desarrollo de Prototipos
PROYECTOS DE DESARROLLO DE PROTOTIPOS | |
Estructura del PROYECTO | |
DOCUMENTO Nº1: MEMORIA
| |
DOCUMENTO Nº2: PLANOS | |
DOCUMENTO Nº3: PRESUPUESTO | |
Estructura de la MEMORIA DESCRIPTIVA | |
1. Antecedentes y objetivos | |
2. Especificaciones de diseño | |
3. Diseño del sistema
| |
4. Implementación física
| |
5. Protocolo de pruebas. Rediseño | |
6. Resultados obtenidos | |
7. Estudio de aplicabilidad
| |
8. Industrialización y fabricación en serie (si procede) | |
Tabla 2.2.4.Proyectos de Investigación
PROYECTOS DE INVESTIGACIÓN | |
Estructura del PROYECTO | |
DOCUMENTO Nº1: MEMORIA
| |
DOCUMENTO Nº2: PLANOS | |
DOCUMENTO Nº3: PRESUPUESTO | |
Estructura de la MEMORIA DESCRIPTIVA | |
1. Planteamiento y objetivos | |
2. Recopilación de antecedentes | |
3. Especificaciones o datos de partida | |
4. Método de trabajo
| |
5. Resultados | |
6. Conclusiones | |
7. Trabajo futuro (si procede) | |
8. Bibliografía | |
Tabla 2.2.5.Proyectos de Productos de Software
PROYECTOS DE PRODUCTOS DE SOFTWARE | |
Estructura del PROYECTO | |
MEMORIA | |
PLANIFICACIÓN Y PRESUPUESTO | |
ESPECIFICACIÓN DE REQUISITOS | |
PLIEGO DE CONDICIONES DE CONTRATACIÓN (si procede) | |
DISEÑO | |
MANUALES TÉCNICOS | |
MANUALES DE USUARIO | |
Contenidos de la MEMORIA | |
a. Descripción del sistema desarrollado (objetivo y contenido del proyecto) | |
b. Descripción del producto (entorno hardware y software necesario, versión, modificaciones sobre versiones anteriores, etc.) | |
c. Relación de documentos que acompañan al proyecto | |
d. Información adicional (metodologías, herramientas y otros productos necesarios para comprender el proyecto) | |
Contenidos de PLANIFICACIÓN Y PRESUPUESTO | |
a. Recursos necesarios para el desarrollo del proyecto | |
b. Planificación temporal (fases y tareas) | |
c. Costes de personal, instalaciones y equipos | |
Contenidos de la ESPECIFICACIÓN DE REQUISITOS | |
Qué debe de hacer el sistema, almacenamiento de información, interfaces con otros sistemas, rendimiento, seguridad, posibles restricciones, pruebas de aceptación. | |
Contenidos del P. CONDIC. DE CONTRATACIÓN | |
Cómo se ha de realizar el sistema, componentes en los que se ha dividido, comunicación entre ellos, equipamiento necesario (estructura del producto). | |
Contenidos de los MANUALES TÉCNICOS | |
Toda la información necesaria para el desarrollo y/o modificación del sistema:
| |
Contenidos de los MANUALES DE USUARIO (*) | |
a. Instalación | |
b. Utilización del sistema | |
c. Configuración y otras operaciones rutinarias (copias de seguridad, etc.) | |
d. Diagnósticos y mensajes de error | |
(*)El usuario final no ha de necesitar ningún otro manual técnico.
2.3. Normas generales de presentación
2.3.1. Normas de estilo
En cuanto a la presentación, hay que tratar que a simple vista se haga una idea positiva de lo que se ha redactado:
- Los párrafos deberán ser lo más cortos posible.
- Las oraciones han de ser directas y completas con el mínimo posible de frases intercaladas.
- Se utilizará un lenguaje claro y preciso.
- Se escribirá en estilo impersonal (‘se ha hecho’ y no ‘yo he hecho’) como muestra la figura 2.1.
- Se utilizará el tiempo futuro para requisitos obligatorios, mientras que para sugerencias o propuestas se usará el tiempo condicional o subjuntivo.
2.3.2. Formatos
Las hojas tendrán tamaño A4 y se escribirá a una sola cara.
En cuanto al tipo, formato y tamaño de letra, interlineado, márgenes y numeración de títulos se utilizarán los predefinidos en las normativas de cada titulación y centro. Están también definidas en el apartado correspondiente de este texto.
2.3.3. Organización del texto
El texto se organizará en capítulos, apartados, subapartados con los párrafos que correspondan. No es recomendable utilizar más de tres niveles.
Se identificará el documento en cada página y se enumerará cada una de ellas respecto al total de páginas del documento, tal como se ilustra en la figura 2.2.
2.3.4. Figuras
Cada figura se acompañará de un pie explicativo de su contenido que tendrá el siguiente formato:
“Figura Número de capítulo. Número de orden dentro del capítulo. Texto explicativo”
El pie de figura se situará debajo de la misma y deberá ser referenciado desde el texto, como muestra la figura 2.3.
Cuando se haga mención a la figura en el texto, deberá ir identificada con su numeración.
2.3.5. Tablas
Cada tabla se acompañará de un título explicativo de su contenido que tendrá el siguiente formato:
“Tabla Número de capítulo. Número de orden dentro del capítulo. Texto explicativo”
El título de tabla se situará encima de la misma. Cuando se haga mención a la tabla en el texto, deberá ir identificada con su numeración, como ilustra la figura 2.4.
Es conveniente que las menciones se hagan previamente a la colocación de la figura o tabla. Así la memoria resultará más fácil de comprender.
2.3.6. Ecuaciones o fórmulas
Las ecuaciones o fórmulas se enumerarán individualmente al final de la línea entre paréntesis. Las dos formas más habituales de numeración son las siguientes:
- Numeración correlativa desde el principio al final del documento.
- Número de capítulo. Número de orden dentro del capítulo.
Después de cada ecuación o fórmula se deberá explicar el significado de cada variable la primera vez que aparece, como se explica en la figura 2.5.
Si hay muchas variables se incluirá un apartado de nomenclatura después del índice de la memoria, donde se indicarán, además, las unidades de cada variable.
2.3.7. Citas bibliográficas
Las citas bibliográficas son imprescindibles en los proyectos y más aún en los de investigación. Se mencionará el autor y, a continuación, se pondrá un número de orden entre corchetes, como se ve en la figura 2.6. El número de orden se asignará según el orden de aparición en el texto o mediante ordenación alfabética de las referencias según el autor. Otro formato alternativo para las referencias bibliográficas consiste en poner el número de orden entre paréntesis precedido por “ref.”.
2.3.8. Acrónimos o abreviaturas
La primera vez que aparezcan acrónimos o abreviaturas se escribirá su denominación completa y, a continuación y entre paréntesis, el acrónimo o abreviatura, como muestra la figura 2.7. En lo sucesivo, se podrán utilizar los acrónimos o abreviaturas directamente. Además, si el proyecto dispone de nomenclatura, se podrán incluir los acrónimos o abreviaturas en la misma.
