Kitabı oku: «Planificación de proyectos de implantación de infraestructuras de redes telemáticas. IFCT0410», sayfa 4
5. Técnicas de elaboración de documentación técnica
La documentación de proyectos sirve para identificar de forma más rápida y fácil todas las características y los aspectos que conforman el proyecto. La elaboración de una correcta documentación proporcionará identidad al proyecto y, de este modo, hace que los usuarios lleguen a conocer las ventajas, los inconvenientes, las funcionalidades, las características, los costes económicos y los beneficios implicados en el desarrollo del proyecto. Para que los documentos técnicos cumplan con todos los requisitos de elaboración deben tener las siguientes características:
1 Lenguaje claro y conciso.
2 Abarcar todos los aspectos del proyecto.
3 Objetivos fáciles de detectar.
4 Hacer referencia a las ventajas y los inconvenientes.
5 Elaborar los documentos con una estructura adecuada.
En un documento técnico debe reflejarse toda la información necesaria que describe el producto, como su objetivo, funcionalidad y características. Para elaborar una buena documentación técnica se deben incluir los siguientes contenidos y técnicas:
1 Descripción general:Identificación del proyecto.Justificación.Objetivo general y específicos.Resultados.
2 Diagrama de bloques del sistema.
3 Esquemático del sistema, determinando cada módulo.
4 Descripción modular:Realizar una descripción de cada módulo.Diagrama esquemático, de estado o vistas, dependiendo del producto.Listado de componentes con todas las características, el tipo, la potencia, el rango de funcionamiento, las especificaciones, etc.Si se hace referencia a un software, se debe definir el sistema operativo de funcionamiento, la versión, los requerimientos de memoria, el disco duro, los periféricos, etc.Protocolos de montaje y funcionamiento del módulo.
5 Lista global de componentes.
6 Análisis de costos de un prototipo y su producción.
7 Protocolos de ensamblaje y pruebas de todos los módulos.
8 Manual de usuario y operativo.
Recuerde
Un documento técnico debe describir el objetivo, la funcionalidad y las características del producto al que corresponde la información que contiene.
Al elaborar documentación técnica es necesario colocar una descripción del producto que informe al lector del alcance deseado. Se debe identificar la fecha de inicio de cada fase de desarrollo e incluir todas las descripciones técnicas además de un cronograma que muestre todas las actividades.
A continuación se muestran unos ejemplos de documentos técnicos correspondientes a un proyecto de redes telemáticas siguiendo los contenidos establecidos en la teoría y que identifican los aspectos y las características más importantes relacionados con el proyecto:
1 Documento de tabla resumen para la descripción general del proyecto:
| Descripción general del proyecto | ||||
| Título del proyecto | Código | |||
| Fecha | ||||
| Fecha inicio | Fecha fin | |||
| Empresa | ||||
| Responsable | ||||
| Integrantes | ||||
| Descripción general del proyecto | |
| Identificación del proyecto | Todos los datos identificativos relacionados con el proyecto, el código del proyecto, el nombre de la empresa, la fecha de elaboración del documento, la localización, el sector y el nombre del encargado o responsable del proyecto |
| Justificación | Razones por las que son necesarias llevar a cabo el proyecto dentro de las características establecidas |
| Objetivo | Ejecución del proyecto en función de las prestaciones y las necesidades requeridas por el cliente que establecen el objetivo por el cual se desarrolla el proyecto |
| Alcance | Definición de la totalidad del trabajo que será necesario llevar a cabo para establecer la finalización del proyecto |
| Resultados | Análisis de los resultados previstos de acuerdo a las condiciones y las necesidades requeridas |
1 Documento referente al cronograma del proyecto:
2 Documento para diagrama de bloques para un sistema de implantación de red telemática:
3 Documento descriptivo de actividades dentro del módulo anterior de diseño de la red:
4 Documento técnico del plano esquemático para el sistema:
5 Documento técnico del plano para la distribución eléctrica en una planta:
6 Documento descriptivo del módulo correspondiente al cableado horizontal de la red telemática:
7 Documento que describe el listado de componentes necesarios:
| N.° | Descripción general | Cantidad |
| 1 | Computador personal Pentium 4 de 2,8 GHz | 15 |
| 2 | Switch 4226T de 26 puertos, proporciona 24 puertos 10/100 con auto detección y dos puertos 10/100/1000 fijos | 3 |
| 3 | Armario Rack | 3 |
| 4 | Pach Panel de 48 puertos categoría 5e | 4 |
| 5 | Bobina de cable UTP cat 5e 305 m | 4 |
| 6 | Conectores RJ-45 | 300 |
| 7 | Roseta Jack RJ-45 | 30 |
| 8 | Canaletas porta cables | 200 m |
| 9 | Bandejas metálicas porta cables | 250 m |
| 10 | Cajetín externo RJ45 CAT.5e | 20 |
| 11 | Sistema de alimentación ininterrumpida (SAI) | 2 |
Nota
Actualmente, la documentación técnica de un producto se considera un importante instrumento de marketing para las empresas reflejando su imagen e identidad en el mercado.
Actividades
8. ¿Para qué sirve y qué proporcionará la documentación técnica? Enumere los requisitos necesarios en la elaboración de documentación técnica.
9. ¿Qué información debe contener la documentación técnica? ¿En qué consiste la descripción modular dentro de la documentación técnica? ¿Es necesario incluir en la documentación un cronograma y las fechas relacionadas con cada fase de desarrollo del proyecto?
Aplicación práctica
Elabore, dentro de la documentación técnica, un cronograma de tiempos que represente los plazos establecidos para las actividades de un proyecto de implantación de red telemática. Las actividades de las que se compone la implantación de la red y sus correspondientes fechas se muestran en la siguiente tabla:
| Actividad | Fecha de inicio | Fecha fin | Duración |
| Recogida de información | 14/05/2014 | 16/05/2014 | 3 días |
| Planificación | 19/05/2014 | 20/05/2014 | 2 días |
| Diseño de la red | 21/05/2014 | 4/06/2014 | 14 días |
| Instalación del cableado | 5/06/2014 | 19/06/2014 | 14 días |
| Instalación de equipos de red | 20/06/2014 | 23/06/2014 | 4 días |
| Configuración de equipos de red | 24/06/2014 | 27/06/2014 | 4 días |
| Certificado de la instalación de red | 30/06/2014 | 1/07/2014 | 2 días |
| Pruebas de red | 2/07/2014 | 9/07/2014 | 7 días |
| Documentación | 10/07/2014 | 11/07/2014 | 2 días |
SOLUCIÓN
A partir de la tabla de plazos de tiempo establecidos, se diseña el cronograma de tiempo sobre las actividades descritas para la implantación de la red telemática como se muestra a continuación:
6. Elaboración de informes y manuales operativos
Durante el desarrollo de un proyecto hay que elaborar un conjunto de documentación a la que se llamará informes y manuales operativos, que son redactados durante las diferentes fases de ejecución como son la supervisión y el seguimiento del proyecto y que proporcionarán toda la información necesaria sobre el proyecto.
Durante este desarrollo se deben elaborar periódicamente los informes que contienen toda la información del progreso del proyecto y que formarán parte de los resultados del mismo. Los informes de progreso deben incluir toda la información relacionada con los avances de ejecución sobre las actividades, los aspectos críticos de gestión, la solución de problemas y todos los aspectos económicos y financieros. En la elaboración de los informes se deben incluir los siguientes contenidos:
1 Datos generales del proyecto.
2 Todas las actividades realizadas en el proyecto.
3 Todo el proceso de ejecución y sus avances.
4 Problemas surgidos y su solución.
5 Evaluación de resultados.
6 Plan de adquisiciones.
7 Evaluación de riesgos.
8 Evaluación del plan económico y financiero.
Importante
La elaboración de informes tiene como principal objetivo proporcionar toda la información sobre el progreso de realización de las actividades incluidas dentro del proyecto durante las fases de seguimiento y control.
Los informes se deben realizar periódicamente durante la ejecución del proyecto y tendrán como finalidad comprobar el grado de cumplimiento sobre los objetivos establecidos y poder tomar decisiones para corregir posibles desviaciones con respecto a la planificación.
Un manual operativo es una herramienta eficaz para transmitir el conocimiento necesario al personal operativo y garantizar el cumplimiento de los procedimientos, las actividades, las responsabilidades y las tareas secuenciales y proporcionar al personal operativo todo el soporte de información que necesita.
En toda empresa, los manuales forman parte de las herramientas para que el personal encargado desempeñe correctamente sus actividades mediante flujogramas y adquieran las responsabilidades encomendadas.
Definición
Flujograma
Representación gráfica de las distintas actividades que componen un procedimiento estableciéndose su secuencia temporal.
Todo manual debe cumplir los siguientes requisitos:
1 Ser práctico y didáctico.
2 Estilo de redacción sencillo, directo y claro.
3 Toda la información debe ser real, actual, con lenguaje comprensible y familiar para los usuarios.
4 Debe incluir elementos didácticos que faciliten la comprensión y la aplicación de los aspectos técnicos sobre los sustantivos mediante diseño conceptual, diseño de la captación y procesamiento.
5 Debe permitir la evaluación de los objetivos del aprendizaje.
Para elaborar un manual operativo deben tenerse en cuenta aspectos como las características generales del proyecto, las características del diseño conceptual, determinar el contexto de aplicación, la modalidad de capacitación y el perfil del usuario que realizará las tareas operativas.
A continuación se muestran unos ejemplos sobre el contenido de la información correspondiente a la elaboración de informes dentro de un proyecto donde se representará la información sobre los avances y la ejecución de las tareas, la secuenciación de actividades, la evaluación de riesgos y la evaluación económica:
1 Informe dentro de un anexo con información del seguimiento de las tareas dentro del proyecto:
2 Informe sobre el proceso de ejecución, secuenciación y avances del proyecto:Informe sobre el avance, la secuenciación de tareas y el progreso en la ejecución de las actividades de un proyecto
3 Informe sobre la evaluación de riesgos en la ejecución del proyecto:
4 Informe sobre la evaluación del coste económico en un tiempo concreto durante la ejecución del proyecto:
Actividades
10. ¿Qué objetivos tienen los informes durante la ejecución del proyecto? ¿Qué deben incluir dichos informes?
11. ¿Qué es un manual operativo? ¿Qué requisitos debe cumplir un manual operativo? ¿Es necesario incluir elementos didácticos en un manual operativo? ¿Qué objetivos tienen estos elementos didácticos?
12. Indique algunos ejemplos sobre los diferentes tipos de informes que se pueden encontrar durante el desarrollo de un proyecto.
Aplicación práctica sobre la elaboración de un informe
Realice un informe sobre la evaluación del coste económico durante la ejecución de un proyecto de implantación de red telemática.
Para cada una de las fases del proyecto se muestra el coste real, el coste planificado y sus valores acumulados. A partir de estos valores se debe elaborar el informe que contenga la representación gráfica para la evaluación de costes al finalizar la fase de implantación de la red telemática señalada en color rojo.
Para realizar la evaluación se tienen los datos relacionados con el seguimiento de los costes durante el desarrollo del proyecto para tres fases de ejecución como se muestra en la siguiente tabla:
| Fase del proyecto | Coste Real | Coste Real Acumulado | Coste planificado | Coste planificado acumulado |
| 1ª FASE: Recopilación de datos | 1.700€ | 1.700€ | 1.620€ | 1620€ |
| 2ª FASE: Diseño de la red | 2.100€ | 3.800€ | 1.900€ | 3.250€ |
| 3ª FASE: Implantación de la red | 24.200€ | 28.000€ | 22.170€ | 25.690€ |
| FECHA ACTUAL | ||||
| 4ª FASE: Pruebas | ----- | ----- | 3.200€ | 28.890€ |
Se pretende obtener la comparación entre el coste real y el coste planificado observando sobre la tabla que el coste real ha superado al coste planificado por diversas causas, las cuales se muestran a continuación:
1 Fase de recopilación de datos: se ha superado el coste planificado por la necesidad de una reunión no programada inicialmente con un experto externo a la empresa que proporcionó mayor información sobre determinados aspectos de la red.
2 Fase de diseño: se ha necesitado una nueva licencia de un software comercial para el diseño de redes.
3 Fase de implantación: se ha necesitado incorporar un equipo más de distribución durante la implantación de la red con respecto a lo planificado inicialmente, aumentando el correspondiente coste de materiales estimados en la planificación.
Se debe representar la evaluación de costes en la siguiente gráfica:
Solución
A continuación se muestra la gráfica sobre la evaluación de costes realizada a partir de la tabla de datos:
Se observa en la gráfica que en cada una de las etapas se ha producido un sobrecoste con respecto al coste planificado, dando como resultado final para la fecha actual un sobrecoste de 2.310 € al finalizar la tercera fase.
Por tanto, se debe ajustar el coste en la última etapa del proyecto para intentar equilibrar el sobrecoste tomando las medidas necesarias antes de finalizar el proyecto.
6.1. Estructura de la información a transmitir
Para elaborar el manual es necesario definir la estructura de la información que se va a transmitir. Dependiendo de las características técnicas y específicas del proyecto que se deben cubrir, los procedimientos y los usuarios a los que va dirigido, el manual se elaborará en base a un modelo estándar y flexible. A continuación se muestra la estructura para un manual operativo:
| Portada | Datos de identificación de la empresa, fechas y datos de control |
| Presentación | Define la importancia y la utilidad del proyecto |
| Índice | Lista ordenada de capítulos y artículos que contiene |
| Introducción | Indica el objetivo, el alcance, el ámbito de aplicación y el contexto del manual |
| Capítulos sustantivos | Aspectos generales = funciones, alcance, responsabilidades y organigrama operativo Procedimientos técnicos = diagrama de flujo, objetivos del procedimiento, criterios y requisitos de aplicación, problemas y áreas de aplicación Cronograma = gráfica con el periodo temporal de realización de actividades Glosario = incluye la definición de todos los conceptos incluidos en el manual |
| Anexos | Incluye información como tablas de datos y características de montaje funcionamiento de los componentes del proyecto |
| Otros | Formatos, ejemplos y catálogos |
Nota
La necesidad de disponer de un manual operativo surge cuando existen actividades complejas que necesitan descripciones precisas y proporcionar una fácil consulta.
A continuación se muestran algunos ejemplos relacionados con el contenido de la estructura de la que se compone un manual operativo de un proyecto. En este caso se incluye un organigrama del equipo de trabajo, el procedimiento técnico para el montaje del cable UTP y su clavija de conexión, un esquema de la distribución y canalización del cableado de la red sobre bandejas porta cables sobre un falso techo y los componentes de una caja de conexión de usuario.
Además, se incluye un ejemplo de la configuración de la red para los equipos de usuario y un anexo técnico dentro del manual sobre el funcionamiento del sistema de ventilación dentro del armario donde se ubican los equipos electrónicos de red.
Dentro de los aspectos generales se puede encontrar el organigrama representativo del equipo de trabajo para el proyecto:
Dentro de los procedimientos técnicos se muestra un ejemplo de instalación con cable UTP de par trenzado con sus correspondientes clavijas de conexión:
1 Primer paso: pelar la cubierta del cable y eliminar el hilo central.
2 Segundo paso: localización de cada hilo según el estándar elegido y la conexión con el conector.
3 Tercer paso: inserción de los hilos con el conector.
Para la instalación de las bandejas que portan los cables para la conexión de los equipos de la red telemática se muestra la información sobre la forma de distribución de las bandejas portadoras por el falso techo como se muestra en el siguiente ejemplo:
Para la instalación de las rosetas en el área de usuario se muestra la composición de la caja que se instalará en la pared y su procedimiento para unir sus piezas:
Dentro del manual se muestra información sobre la configuración de los equipos de usuario conectados a la red así como su conexión correspondiente con los equipos electrónicos de acceso y distribución de la red:
El procedimiento técnico para la puesta a tierra en las instalaciones de cableado estructurado se muestra a continuación:
Sistema de alimentación en trifásica TT. Al ester el neutro a tierra, la tensión entre fase y tierra nunca será una tensión compuesta entre fases
En los anexos se puede encontrar el funcionamiento del sistema de ventilación del armario donde se ubican los equipos electrónicos de red donde la salida de aire se produce por la parte superior y la entrada por la parte inferior:
6.2. Elaboración de guías textuales y visuales para manuales operativos
El objetivo de un manual didáctico es servir como apoyo expresando de forma clara y directa todo su contenido para que la figura operativa pueda realizar su ejecución.
Para elaborar guías textuales y visuales dentro de un manual operativo se pueden utilizar recursos variados como dibujos, imágenes, esquemas, ilustraciones, fotografías y mapas. Una guía textual y visual debe transmitir claramente las ideas abarcando desde las actividades más simples hasta las actividades más complicadas que implica la toma de decisiones cuando surge algún inconveniente.
Un procedimiento incluido dentro de un manual operativo en forma de guía textual y visual debe contener una descripción del procedimiento y su diagrama correspondiente.
Descripción del procedimiento
En la descripción del procedimiento debe presentarse secuencialmente cada una de las operaciones que se deben realizar. Cada operación debe ser explicada y se debe explicar en qué consiste, además de reseñar el puesto responsable de su ejecución, usando un texto claro y conciso explicando cómo, con qué, cuándo, dónde y el tiempo durante el que se lleva a cabo el procedimiento.
Definición
Procedimiento
Secuencia de operaciones y su método de ejecución realizada por una o varias personas y que son necesarias para realizar una determinada función.
Diagrama del procedimiento
El diagrama de procedimiento tiene como objetivo facilitar la comprensión del usuario o persona que lo consulta. Los diagramas de flujo representan y permiten visualizar secuencialmente todas las actividades que se deben desarrollar dentro del procedimiento y sus responsables de ejecución.
Su uso principal está relacionado con el análisis de procedimientos para representar una descripción resumida del conjunto facilitando la compresión de dichos procedimientos. Un diagrama de flujos está compuesto por símbolos en el que cada uno de ellos tiene un significado concreto como indica la siguiente tabla.
| Símbolos | Significado | Símbolo | Sígnificado |
 | Actividad |  | Documento |
 | Inicio o terminación de flujo |  | Flujo o línea de unión |
 | Decisión / alternativa |  | Conector de operación |
 | Conector de página |  | Archivo |
 | Archivo temporal |  | Insertar nota |
Importante
Un diagrama de flujo es un recurso gráfico que representa el desarrollo de actividades y que generalmente presenta un único punto de inicio y un único punto de finalización.
Ejemplo de diagrama de flujo
Se elabora un diagrama de flujo que represente un procedimiento que lleve a cabo una actividad; en este caso, la actividad será la de instalar y conexionar un router para tener acceso a Internet en una oficina o domicilio. El comienzo del diagrama es comprobar si hay servicio de Internet y el final del flujo será la comprobación para del funcionamiento de Internet.
Antes de nada se va a definir el proceso completo para instalar un router en una oficina o domicilio particular. Primero se va a enumerar todo el proceso empleando cuestiones que, dependiendo de su respuesta, se deberá actuar de una forma u otra y posteriormente aplicarlas al diagrama. A continuación se muestran los pasos a seguir para instalar un router particular:
1 Saber si hay servicio de Internet (decisión/actividad).
2 Saber si se tiene el router y su cableado de conexión correspondiente (decisión/actividad).
3 Conectar el router y comprobar su funcionamiento (actividad/decisión/actividad).
Basándose en estos pasos se puede elaborar el diagrama que permita al usuario llevar a cabo este procedimiento de instalación del router, recordando que el diagrama debe ser resumido, claro y preciso para facilitar la comprensión. A continuación se muestra el diagrama elaborado:
Se puede observar en el anterior diagrama cómo se realiza el recorrido de flujo desde el inicio hasta el final. Los tres símbolos de decisión permiten variar la dirección dependiendo de si se cumple o no la condición escrita en su interior. Los símbolos de color azul determinan las acciones que se llevan a cabo en cada momento durante el recorrido sobre el diagrama.
Actividades
13. Indique la estructura que debe tener un manual operativo. ¿Qué tipo de capítulos sustantivos se pueden encontrar dentro de un manual operativo?
14. ¿Qué debe contener un procedimiento dentro de un manual operativo? ¿Qué es la descripción del procedimiento?
15. ¿De qué forma se representan las actividades en un diagrama de flujo? ¿Qué uso principal tiene un diagrama de flujo?
Aplicación práctica sobre la elaboración de un diagrama de flujo
Elabore un diagrama de flujo que represente las fases de implantación para una red telemática. En este caso se debe comenzar con la planificación y terminar con las pruebas de red. El proceso completo secuencialmente se muestra a continuación:
Inicio
1 ¿Planificación completa? (decisión) y completar planificación (actividad).
2 ¿Diseño completo? (decisión) y completar diseño (actividad).
3 Instalación (actividad).
4 ¿Instalación completada? (decisión).
5 Pruebas (actividad), pruebas superadas (decisión), solucionar errores (actividad).
Fin
A continuación se muestra el diagrama de flujo que debe ser completado con el proceso secuencial descrito anteriormente:
Solución
Siguiendo la secuenciación del enunciado se completa el diagrama que define las actividades correspondientes a la implantación de una red telemática de la siguiente manera:
