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:
- Lenguaje claro y conciso
- Abarcar todos los aspectos del proyecto.
- Objetivos fáciles de detectar.
- Hacer referencia a las ventajas y los inconvenientes.
- 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:
-Identificación del proyecto
-Justificación
-Objetivo general y específicos
-Resultados.
- Diagrama de bloques del sistema.
- Esquemático del sistema, determinando cada módulo.
- 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.
- Lista global de componentes.
- Análisis de costos de un prototipo y su producción.
- Protocolos de ensamblaje y pruebas de todos los módulos.
- Manual de usuario y operativo.
Recordemos! 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 identificarla 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.
Información que debe contener una documentación técnica
- Descripción general
- Diagramación de bloques
- Esquematización del sistema
- Descripción modular
- Lista global de componentes
- Análisis de costo
- Ensamblaje y pruebas de los módulos
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:
- 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 |
|
| 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 |
- Documento referente al cronograma del proyecto:
Documento técnico sobre el cronograma de un proyecto
|
ACTIVIDADES
|
INICIO
|
DURACIÓN (DÍAS)
|
FIN
|
| A |
01/05/2014 |
5 |
06/05/2014 |
| B |
06/05/2014 |
4 |
10/05/2014 |
| C |
03/05/2014 |
10 |
13/05/2014 |
| D |
05/05/2014 |
6 |
11/05/2014 |
| E |
09/05/2014 |
5 |
14/05/2014 |
- Documento para diagrama de bloques para un sistema de implantación de red Telemática:
Diagrama de bloques del sistema
PLANIFICACIÓN DEL PROYECTO –> DISEÑO DE LA WEB –> IMPLANTACIÓN –> PRUEBAS DEL SISTEMA
- Documento descriptivo de actividades dentro del módulo anterior de diseño de la red:
BLOQUE DE DISEÑO DE LA RED
-Definición del equipo de red
–Equipos de acceso
–Equipos de distribución
-Distribuidor y ubicación de los equipos de red
–Definición de la localización de los equipos de red
–Planos de localización
-Dueño de la estructura del cableado
—Cableado vertical
–Cableado horizontal
–Puesto de usuario
-Esquemático del conexionado de equipos de red
- Documento técnico del plano esquemático para el sistema:
Plano esquemático de la distribución de cableado del sistema
- Área de Trabajo (Patch Cord)
- Salida (Face Píate)
- Cableado Horizontal (Cable UTP/FTP)
- Cuarto de Telecomunicaciones (IDF) (Rack/Plate Panel)
- Cableado Vertical (Backbone)
- Documento técnico del plano para la distribución eléctrica en una planta:
Plano sobre la distribución eléctrica en una planta
- Documento descriptivo del módulo correspondiente al cableado horizontal de la red Telemática:
Descripción de la estructura de cableado horizontal de una instalación de red
- 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 |
Importante! 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.
Relacionado
