RECOMENDACIONES PARA ELABORAR DOCUMENTACIÓN TÉCNICA
Resumen
Este artículo contiene recomendaciones para la elaboración de documentos de ingeniería que sean útiles para quienes los usan y para ello tienen que ser fáciles de entender y contener la información que se necesita. Esto, que parece trivial, pocas veces se cumple. Mucha de la documentación que circula presenta los siguientes inconvenientes:
• Tiene mucha información, pero justo falta el dato que más necesitamos.
• No estamos seguros de que sea la versión válida.
• Parece escrita para un físico nuclear de la NASA, el instalador no la entiende.
• Los datos están equivocados y/o hay datos contradictorios en el mismo juego de documentos.
• Es demasiado extensa.
• No es fácilmente visible en un teléfono móvil, o computadora.
• Pensada para ser impresa en tamaños de papel del cual no tenemos impresora.
Y esto tiene una triste consecuencia: como no tiene lo que necesito, no la entiendo, no la puedo ver, ¡no la uso!
Este artículo está escrito basado principalmente en mi experiencia en empresas de telecomunicaciones, por esa razón los ejemplos son de ese rubro. En estas empresas en general la documentación técnica tiene bastante falencias generando numerosos sobrecostos debido a que no se está seguro de la ingeniería de detalle de cada instalación, obligando en casi todos los casos a dos intervenciones, la primera a ver que hay (los llamados relevamientos) y la segunda para la implementación de lo que se quiere hacer. Esto sin contar las numerosas “vueltas a obra” originadas en ingenierías incumplibles o que no coincidían con los materiales con los que se cuenta, o faltantes, etc.
Aunque parezca una verdad de Perogrullo, no está de más resaltar que la documentación de ingeniería se elabora PARA SER USADA. La documentación de ingeniería debe llegarles a todos los destinatarios con el contenido que realmente necesita y entienda cada uno, y en un formato físico que pueda acceder fácilmente. Si la documentación no llega de esta forma al contratista o supervisor o quien tenga que usarla, o no le es útil, no sirve absolutamente para nada.
Usar la documentación de ingeniería SIEMPRE REDUCE COSTOS. De hecho, la principal función de un trabajo de ingeniería es asegurar el desempeño de un proyecto con el menor costo posible. Y el costo no solo debe evaluarse con la compra de componentes y materiales, sino también en viajes, viáticos, retrabajos, reparaciones y otros tipos de actividades improductivas que se reducen drásticamente con una buena elaboración de ingeniería.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 1 de 14
Algunas frases para tener pegadas en la oficina de ingeniería
• UNA HORA DE ESCRITORIO AHORRA 100 HORAS DE OBRA
• LA LEY DEL BUEN CARPINTERO: MEDIR DOS VECES Y CORTAR
Elaborar la documentación de ingeniería es un ejercicio de pensamiento
A veces ocurre que uno “cree” que tiene todo claro en un proyecto, hasta que empieza a elaborar la ingeniería. Ahí aparecen las dudas, las cosas que nadie definió, las que son impracticables o carísimas. También, a veces nos pasa que estamos convencidos que sabemos algo, hasta que tenemos que explicárselo a otro. Y una de las funciones de la documentación técnica es justamente explicarle a otro lo que queremos.
La mente humana es asombrosamente poderosa, pero es incapaz de tener en cuenta más de tres o cuatro datos a la vez. Para eso necesita de alguna forma de ayuda, y ahí es donde aparece la documentación técnica. Por ejemplo, si tenemos que poner un tornillo en un mueble, es muy simple definir el diámetro y largo del tornillo, si lleva o no arandela, el diámetro y profundidad del agujero, el tipo de cabeza del tornillo, la posición respecto del borde de la madera, cuantos tornillos se colocan por pieza de madera, a que distancia está el próximo, etc. Lo que es difícil es expresar todo esto junto sin la ayuda de un plano. Y al elaborar el plano nos percatamos que no habíamos tenido en cuenta el espacio para la herramienta para el ajuste el tornillo, lo que nos obliga a cambiar el tipo de cabeza, por ejemplo. La mente humana puede manejar situaciones infinitamente más complejas que colocar un tornillo, sin embargo, este es un ejemplo simple de la necesidad de contar con la ayuda de un plano o una maqueta para “poner todo junto” y usar eso en el marco de un proyecto más grande.
¿Qué es un documento técnico?
Se considera “documento técnico” a toda aquella forma de expresar algo que tenga registro seguro y confiable. No está limitado a planos (clásicos), manuales o memorias descriptivas con textos y gráficos. Hoy en día hay otros recursos como ser videos, fotos o aplicaciones que perfectamente cuadran en la categoría de documento técnico. Para considerar que se trata de un documento, debe estar bien en claro
• Donde aplica (a que equipo, que proyecto, a que tipo de proyectos, etc).
• Donde está guardado.
• Quien se responsabiliza por el contenido y cuando lo hizo.
¿para qué hacemos cada uno de los documentos elaborados?
Preguntarse para que se hace un documento es la parte más importante en el proceso de elaboración de la documentación técnica, porque obliga a pensar en los destinatarios y en el contenido. Hay infinitas respuestas y cada una
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 2 de 14
dependerá del proyecto en el que estemos involucrados. Algunas de esas respuestas pueden ser:
• Para resumir en pocas hojas todo lo que “se nos va ocurriendo” a medida que elaboramos la documentación. Este es el motivo más importante a mi criterio, acerca del motivo por el cual elaboramos documentación técnica. Recordemos que se trata de un ejercicio de pensamiento.
• Para transmitirle a otra persona lo que tiene que hacer y cómo hacerlo
• Para ser usada en un futuro, y no empezar desde cero en otro proyecto similar
• Para ponerle límites a un proyecto, es decir se hace lo que dice el plano, ni más ni menos de eso.
• Para guardar registro de lo que se hizo
La única respuesta que es inaceptable es “hago este documento porque me lo pidieron” aunque no entiendo para que sirve, si alguien lo va a usar, si solo va a ocupar unos megas en el disco sin que nadie lo lea jamás. Resumiendo: la ingeniería se elabora PARA SER USADA.
¿A quién está dirigida esta documentación?
Esta pregunta está muy relacionada con la anterior, porque si hago un plano de instalación, por ejemplo, es porque tengo que transmitirle al instalador como quiero que se implemente mi proyecto. En ese caso el destinatario está claramente definido. Lo que debo preguntarme en esta instancia es ¿entiende el destinatario lo que quise expresar en el plano? ¿necesita alguna información complementaria?
Por ejemplo: una memoria de cálculo de una estructura de soporte de antenas (como ser un mástil), contiene prácticamente toda la información que necesita un instalador para montarlo. Sin embargo, en general está expresado de una manera que es complicada de entender para dicho instalador, y puede cometer errores al usar un documento que no es para él.
En este ejemplo la memoria de cálculo tiene como objetivo guardar los criterios utilizados en el diseño de la estructura y está escrita para ser utilizada por un ingeniero en estructuras, para habilitar la estructura en el municipio, o en caso de agregar más cargas en el futuro, y también para tener un respaldo legal en caso de ocurrir algún inconveniente. Mientras que el plano de montaje es un documento para ser leído por un instalador, debe ser simple, conciso y contener instrucciones y dimensiones que puedan materializarse con los conocimientos y herramientas que posee el instalador a su alcance.
Hablar con los destinatarios
El área de ingeniería que elabora la documentación no debe estar aislada de los usuarios de los documentos que elaboran. Una buena recomendación consiste en elaborar un primer documento de cierto tipo (un documento piloto o prototipo),
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 3 de 14
compartirlo con los destinatarios (que pueden ser sectores de obra, de compras, o el mismísimo cliente final) y preguntarle:
• ¿Lo entendés? ¿Qué dice? ¿Qué parte es confusa?
• ¿Sabés donde está archivado?
• ¿Qué te falta? ¿Qué está de más?
• ¿Sirve el formato? ¿lo podés usar en tu lugar de trabajo?
• ¿Podés hacer eso que dice con los recursos disponibles?
Este lazo de realimentación es fundamental para la elaboración de documentos de ingeniería que sean realmente útiles.
La estética y los fotomontajes
La estética de la documentación técnica, sobre todo de los planos, fue la moneda corriente en el siglo XX. Los planos eran “lindos” y los dibujantes verdaderos artistas que se esmeraban por cuidar hasta el más mínimo detalle, desde la normalización de la letra, hasta el balance visual como en cualquier obra de arte. Esto que parece solo estético traía aparejado otro beneficio, el proyectista o el dibujante al mirar horas el plano mientras lo elaboraba, lo entendía lo analizaba, y si detectaba algún error era el momento de corregirlo. Por otro lado, durante el siglo XX la documentación técnica era usada por técnicos que sabían leerla e interpretarla, y de hecho disfrutaban de esa estética como quien lee un libro atrapante.
Ocurre que actualmente al menos en telecomunicaciones, esa camada de técnicos está desapareciendo y los usuarios de la documentación técnica no tienen la formación mínima necesaria para leer e interpretar algo hecho en el formato del siglo XX. Difícilmente alguien que esté realizando un cableado estructurado, uno de fibra o quien se auto percibe electricista y está realizando una instalación eléctrica, entienda un plano con simbología eléctrica o pueda distinguir una vista en planta o una de elevación y su correspondencia. Por esa razón hicieron su aparición algunos recursos como ser los fotomontajes, donde se superpone sobre una foto del lugar, el recorrido de cables, o el lugar donde ubicar un equipo, o alguna modificación a realizar. Ocurre también, que quien confecciona este tipo de montaje, tiene pobres o nulos conocimientos de perspectiva, y de la herramienta que usa para crear los dibujos resultando en un gráfico horrendo en general desproporcionado, más parecido a un meme rudimentario que a un documento de ingeniería. Pero la parte “buena” de estos fotomontajes, aunque rudimentarios, son “entendibles” por el perfil de personas que actualmente se contrata para materializar las instalaciones.
Hay que tener en cuenta que la tendencia actual en las instalaciones es que sean hechas por personas cada vez menos capacitadas, con cada vez menos herramientas adecuadas, y que -muy lamentablemente- no se sentirán orgullosas de su trabajo, no es más “su obra de arte”.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 4 de 14
Ya no se puede revertir la corriente y pensar que la documentación del siglo XXI tenga los estándares de belleza del siglo XX, pero se puede mejorar.
Es recomendable que el reemplazo de documentación más “elegante” por estos fotomontajes, planillas y esquemas rústicos siga los mismos lineamientos de la documentación “clásica”, es decir que los datos sean ciertos, que sean útiles, sean interpretables por el usuario final y se pueda identificar quien lo hizo, cuando lo hizo y donde se lo archiva. Aun con fotomontajes, la estética se puede seguir cuidando, por ejemplo, que quienes realizan estos documentos sepan identificar los puntos de fuga, corregir distorsión de los lentes de las cámaras y también de los celulares, que de a poco van a destronar a las cámaras.
La otra recomendación es dedicarle tiempo a “embellecer”, ya sabemos que no solo tiene fines estéticos, es tiempo dedicado a pensar en el proyecto, en la instalación, y es donde se identifican problemas que detectados a tiempo son solo minutos de ingeniería y si pasan a la obra serán horas días o semanas de atraso y miles de pesos de costo.
Esta transición de planos “clásicos” a fotomontajes trajo aparejado otro cambio, relacionado con el “conforme a obra”. En documentación clásica el conforme a obra es un estado de la documentación, es decir es una revisión de la documentación existente, donde se reflejan las modificaciones hechas en la obra, debido al grado de libertad que tiene el instalador para pequeñas modificaciones inconsultas. Cuando se trata de registros fotográficos el concepto de conforme a obra es completamente distinto. Se trata de un nuevo set de fotografías donde se muestra “como quedó”. En este caso no se trata de un estado de revisión, se trata de un nuevo documento.
El tamaño de letra y los colores
Siempre se debe tener en cuenta que el documento que se elabora se debe poder leer e imprimir. La mayoría de los usuarios de documentación de ingeniería del rubro telecomunicaciones no cuentan con nada más elaborado que una impresora de tamaño A4 en blanco y negro e imprimen en papel de baja calidad. Si un documento está pensado para ser impreso, es altamente recomendable que cualquier parte de un plano y los tipos de letra sean de al menos 2 mm. Si se identifican distintas partes de un plano por colores, tener en cuenta que se imprimirá en blanco y negro. La conversión de imágenes en colores a blanco y negro depende mucho de la herramienta utilizada, tanto para crear el documento como para pasarlo a ByN. Por ejemplo, el Autocad tiene tabla de colores con grises y también monocromática (solo negro), pero solo funciona con ciertos colores standard. Otro problema habitual es el amarillo, en general muy usado en Autocad con fondo negro, se debe prestar atención a que cuando se imprime o se convierte a PDF no resulte en amarillo con fondo blanco, que es imposible de ver bien.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 5 de 14
Recomendación: antes de enviar un documento a obra, o a los supervisores o usuarios en general, asegurarse que se ve claramente, que se puede imprimir en A4 blanco y negro (sin perder información obviamente).
Recomendaciones para Autocad: trabajar el plano (2D o 3D) en el espacio del modelo y en colores standard. El espacio del modelo debe estar todo en escala 1:1 es decir se mide en las unidades de creación de documento. De este modo todas las herramientas que se usen para poner cotas funcionarán adecuadamente. En el espacio del modelo no debe haber ni textos ni cotas ni rótulos, solo el modelo.
Todos los textos y las cotas se escriben en el espacio del papel con letra de 2 mm como mínimo. El formato en el espacio del papel debe tener dimensiones de A4 para poderlo imprimir y pasar a PDF sin errores en la escala. Con versiones modernas del PDF se puede medir directamente siempre y cuando se haya creado teniendo en cuenta estas observaciones.
De esta manera la letra es siempre igual, cualquiera sea el nivel de zoom elegido para mostrar el plano. Si alguna parte importante del plano al verla en el espacio del papel resulta que tiene menos de los 2 mm que se estableció como lo más chiquito visible e imprimible, en ese caso conviene hacer una nueva ventana (viewport) con más zoom hasta que el detalle sea visible. Nunca hacer una copia con mas zoom (escalada) en el espacio del modelo, de hacer eso se pierde la capacidad de medir sobre el plano, de colocar cotas y quedan dos copias del mismo dato en el plano. Si ese pedazo ampliado luego se quiere modificar, debe tenerse en cuenta que también hay que modificar (ver párrafo de datos repetidos)
Las normas
Mucha documentación técnica, sobre todo pliegos de especificaciones técnicas hacen referencia a normas locales o internacionales. Muchas veces esto se hace para que el documento “parezca más serio”, y resulta en la práctica que referenciar a una norma solo por ponerla, hace al documento menos serio.
También ocurre que es demasiado frecuente que quien referencia a esa norma ni siquiera la haya leído, y si la leyó debe también entenderla, asegurarse que aplique en su caso específico, y también que se pueda aplicar en el país.
En general las normas sirven para normalizar (valga la redundancia), esto significa que las especificaciones de algún producto o las condiciones de uso sean conocidas e iguales para todos los fabricantes que verifican la norma, así se los puede comparar como se dice en lenguaje coloquial “comparar peras con peras”. Por ejemplo, solo se puede comparar una ficha (enchufe) que cumple con IRAM 2073 con otra ficha que cumple la misma norma, primero y fundamental porque ambas son aptas para ser usadas en la Argentina, y segundo porque su construcción es similar. Pero con certeza habrá muchos fabricantes con calidades marcadamente distintas que cumplen IRAM 2073
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 6 de 14
A veces está difundida la idea que los productos que cumplen normas “son buenos” por el solo hecho de cumplirlas, y no siempre es así. Claramente si un producto no declara cumplir con ninguna estandarización, con certeza estamos frente a un producto de desempeño impredecible.
Ejemplo de norma citada, aunque no se sabe por qué: en el rubro de las telecomunicaciones es moneda corriente encontrar que un equipo de radio “debe cumplir normas MIL-STD” por ejemplo. Eso se escribe en las especificaciones porque quien escribe la especificación leyó en los folletos de los equipos que le parecieron adecuados para su proyecto, que dichos componentes cumplen con normas MIL-STD. Pero en general nadie se tomó el trabajo de leer dichas normas, interpretarlas y sobre todo entender por qué se especificó eso. ¿Realmente necesito un equipo que cumpla con los estándares del departamento de defensa de USA? ¿Conozco cabalmente cuáles son esos requisitos o simplemente los imagino?, si no es así ¿para qué pido este requisito? Lo de las normas MIL-STD es solo un ejemplo, hay muchísimas especificaciones redactadas a veces demasiado superficialmente con referencias a normas que no son necesarias o son contraproducentes o encarecen innecesariamente un proyecto
Recomendación: antes de nombrar una norma o hacer referencia a ella debemos estar seguros de los siguientes puntos
• Que la hayamos leído y sobre todo que la hayamos entendido.
• Que el cumplimiento sea útil para nuestro proyecto y el no-cumplimiento sea nocivo.
• Que sea aplicable y cumplible.
• Si solo nos interesa un punto de una norma, hacer referencia a ese punto solamente no a toda la norma.
Los datos inventados
En toda documentación hay datos que son ciertos y se basan en cálculos, mediciones, especificaciones, etc. y hay otros datos que no se conocen o “se supone que son de determinada manera”. En la elaboración de documentos técnicos, si alguna dimensión tiene cota es porque se midió, se calculó o debe ser así. Lo mismo pasa con materiales o descripciones de alguna parte.
Recomendación: No ponerles cota a partes que no se midieron, no se sabe o es indistinto cuanto miden. Lo mismo con las descripciones.
Por ejemplo, si se está elaborando un plano de ubicación de equiposen un rincón de una sala, las dimensiones que importan son las distancias de ese equipo respecto de algo conocido como ser una puerta, una columna etc. A veces se dibuja toda la sala solo para tener idea de la ubicación del equipo en el contexto general, pero las medidas de toda la sala no se conocen con exactitud (ni son necesarias para el objetivo del plano). No se debe caer en la tentación de usar indiscriminadamente el comando “dimensión” del Autocad y llenar el plano de
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 7 de 14
cotas que en realidad son inventadas. Se debe tener en cuenta que ese plano puede ser usado más adelante para ubicar otro equipo y si las medidas parecen exactas (pero no lo son) puede llevarnos a cometer errores. Una alternativa muy valiosa para esta situación es expresar cuando una dimensión es estimada, aclarándolo explícitamente en la cota (por ejemplo: 5 m aproximadamente).
Lo mismo pasa con materiales u otras descripciones. Por ejemplo, si no se está seguro que lo que se ve como una pared, es un “tabique de mampostería de 15 cm”, no poner esa clase de detalle. Solo se debe ser tan específico cuando se está seguro del dato.
Los datos inciertos o de posible mala interpretación
Es habitual encontrar datos que, si bien pueden ser correctos, se corre el riesgo que no sean bien interpretados por quien lea el documento, o les falte algo para un entendimiento cabal.
Recomendación: Nunca asumir que la primera interpretación es la correcta.
Por ejemplo: Altura de la antena 54 metros. Parece un dato claro y concreto, pero ¿54 metros a contar de dónde? Por ahí el que lo escribió tenía en claro que eran 54 metros desde la base del mástil, y el mástil apoya en un segundo piso. Pero si no lo aclara, otro puede pensar que se trata de 54 metros desde el nivel del terreno. En este caso un esquema con cotas es más seguro y práctico.
Otro ejemplo: La antena orientada con azimut 185°, aquí pasa lo mismo ¿Cómo se yo que quien lee sabe que el azimut se mide en el sentido de las agujas del reloj? Además ¿Cómo se yo que el que lee sabe que el azimut se referencia al norte geográfico? Es muy común que el instalador use brújula y no tenga ni idea de la diferencia entre el norte magnético y el geográfico, y en ciertas zonas (por ejemplo en Misiones) pueda errarle por 14°. Nuevamente aquí un gráfico aclara la situación mejor que mil palabras. Volvemos aquí a un tema ya tratado, “el instalador” al que se hace referencia, ya no es más un antenista, que tenía bien claro los conceptos de azimut, uso de brújulas, etc. Es muy común encontrarse con cualquier persona que tiene habilitación física para hacer trabajos de altura, y esa persona limpia vidrios, es pintor de altura o albañil. La documentación elaborada la debe entender esa persona, olvidémonos que vayamos a encontrar un antenista certificado.
Coordenadas del sitio: En radiocomunicaciones un dato que suele ser confuso son las coordenadas del sitio, debe expresarse claramente si se trata de grados minutos y segundos o grados decimales.
Los datos ambiguos e inútiles
En mucha documentación técnica y prácticamente en la totalidad de los pliegos de especificaciones técnicas aparecen frases tales como
• El soporte deberá ser /es suficientemente robusto
• La instalación se hará/se hizo siguiendo las reglas del buen arte
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 8 de 14
• La instalación se hará/se hizo según los reglamentos locales
• Los equipos serán/son modernos y de reciente generación
• La interfase de control será/es de fácil interpretación
Recomendación: directamente eliminar este tipo de expresión, no aportan nada al proyecto no describen nada y no le sirve a nadie.
Recordemos que somos ingenieros, no abogados. Los ingenieros decimos como se hacen las cosas, no como deberían hacerse ni ponemos frases que solo sirven para una discusión posterior acerca de su interpretación. Por lo tanto, las frases de los documentos de ingeniería deben ser específicas y concretas. Por ejemplo, el primer caso “soporte robusto”, debemos pensar ¿Por qué pido que sea robusto?, si se trata, por ejemplo de un soporte para paneles fotovoltaicos que se van a instalar en una zona de mucho viento, especificar este requisito, de este modo se alerta al diseñador que es lo que realmente queremos expresar. Lo mismo si es zona inundable o lo que fuese, no esperemos que alguien adivine lo que queremos, basándose en frases genéricas.
Los datos inentendibles
Así como hay datos ambiguos o intrascendentes también muchas veces aparecen datos que nadie los entiende. No parece razonable que aparezcan en una documentación técnica, sin embargo, son más frecuentes de lo esperado.
La clave para evitar este problema es: si yo no lo entiendo, menos lo va a entender otro.
Por ejemplo, estoy elaborando la documentación del tendido de cable coaxial de un equipo de radio en UHF, al buscar los conectores encuentro el que me parece adecuado para lo que necesito (por ejemplo un N macho para cable de ½ “). El folleto, además de los datos que me interesan, dice que tiene una intermodulación pasiva (PIM) de -112 dBm. Supongamos que no sé qué es eso, y si no lo sé, es porque no lo necesito para mi instalación. Y si no se lo que es no debo ponerlo como especificación. Probablemente el instalador tampoco lo sepa y hasta puede pasar que alguien (creyendo que es un dato importante en una instalación de UHF) termine comprando algún conector que si lo cumpla, pero no es el adecuado para un equipo de UHF.
Igual hoy en día está Google que todo lo sabe y cuando aparece una cosa de estas lo mejor es googlear, y habiendo hecho esto hubiésemos encontrado que ese es un parámetro crítico en futuras instalaciones de 4G, pero intrascendente en UHF.
Las especificaciones que no necesito
Esta es otra situación muy frecuente en la documentación técnica que típicamente complica el proceso de compra o el de provisión de materiales.
Se trata de especificar cosas que aparecen en la hoja de datos del equipo, pero no son ni siquiera necesarias para la aplicación donde se los usará. Si yo quiero
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 9 de 14
50 m de un cable de cobre de 10 mm2 de sección color rojo, el que se instalará sobre una bandeja, para que voy a especificar la máxima tensión de tracción, la cantidad de oxígeno contenido en el cobre y muchas otras especificaciones que no las voy a necesitar en esa aplicación. Este es un caso distinto del anterior, porque tengo bien en claro de que se trata, simplemente no necesito esa especificación para mi proyecto, o cualquiera sea me funcionará igual.
Recomendación: solo especificar lo que se necesita, sobre la base que “si no se cumple esto, entonces no sirve”. Esto hace que se abra más el abanico de posibles proveedores o alternativas, lo cual agiliza y abarata el proceso de compra y provisión.
Especificaciones y requisitos
La confusión entre especificación y requisito es más frecuente en los pliegos de licitaciones que en la documentación técnica de obra, aunque en esta última suele ocurrir también.
Aunque parezca demasiado formal, primero consultemos el diccionario
• Requisito: Circunstancia o condición necesaria para algo.
• Especificar: declarar con individualidad algo.
Llevado esto al mundo de la documentación técnica cuando estoy poniendo un requisito, estoy pidiendo algo que quiero que ocurra y sirva para lo que pretendo hacer, mientras que cuando especifico, en general estoy describiendo alguna característica necesaria o bien como haría para lograr que se cumpla ese requisito.
Siempre voy a estar en condiciones de establecer un requisito, porque es lo que yo quiero. A su vez este requisito puede ser mandatorio o simplemente deseable (no obligatorio)
Respecto de las especificaciones, ahí no siempre estamos capacitados para definirlas, depende de cuanto sepamos del tema en cuestión. Si somos especialistas, en general las especificaciones son muchas y los requisitos pocos (no hace falta explicar para que pedimos algo que dominamos), mientras que si no somos especialistas los requisitos son lo más importante y las especificaciones son pocas aunque en general mandatorias.
Un ejemplo clarifica mejor las cosas
Requisito (lo que quiero): Un sistema de radiocomunicaciones móviles en UHF con un alcance mínimo de 15 Km.
Especificación si soy especialista en el tema (como la haría yo, o como quisiera que lo haga otro): El sistema tendrá una potencia mínima de 20W en la repetidora y de 5W en los portátiles, la antena será omnidireccional de al menos 8 dBi de ganancia, la pérdida en los cables de la repetidora será menor a 3 dB.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 10 de 14
En general el requisito describe lo que necesita el usuario final, en este caso un sistema de radiocomunicaciones en UHF que cubra un pueblo y sus alrededores. En realidad, al usuario final no le interesa el tipo y la ganancia de las antenas (a veces ni sabe que son), tampoco las potencias involucradas. Si habla por radio hasta 15 Km de la base, estará satisfecho con cualquier solución.
A diferencia del requisito que lo escribe el usuario final (es decir el que necesita cierta funcionalidad), las especificaciones las escribe un especialista en la materia y en general describe como lo haría él.
Cuando en un mismo documento conviven requisitos con especificaciones, suelen aparecer contradicciones o limitaciones innecesarias. Esto se debe a que otro técnico usando otra solución, puede satisfacer los requisitos con soluciones que tienen distintas especificaciones. Aquí aparece la disyuntiva ¿a qué le hago caso al requisito o a la especificación?
A mi entender la prelación es primero requisito y luego especificación, pero no para todos el orden de prioridad es el mismo. Yo creo que si no se cumple el requisito (si la solución no sirve para lo que se la pide), directamente no debe considerarse. En cambio, si cumple el requisito, pero lo hace en forma distinta de la forma que yo creía que podía resolverse, puedo tenerlo en consideración.
En el caso particular de los pliegos de licitaciones, es casi cotidiano el error de darle a escribir el pliego al técnico. El técnico describe como él solucionaría lo que se imagina que necesita el usuario final, pero en general no lo consulta ni cree que haya alternativas válidas. Su solución es la mejor. Esto resulta en un pliego lleno de especificaciones y totalmente disociado de las necesidades reales del usuario que necesitaba una funcionalidad, no un tipo de solución específica También es frecuente que el técnico llene de especificaciones el tema que conoce (aunque no sea el foco del documento), y queden otros temas poco definidos o poco claro si son especificaciones o requisitos. Es bastante habitual encontrar pliegos por enlaces de microondas donde se le dedican 5 hojas al alambrado perimetral, a las características del portón, su candado, etc, y del objeto de la licitación (el radioenlace) haya mas dudas que certezas.
Recomendación, si necesitamos algo de lo cual no somos especialistas, establecer bien los requisitos y respecto de las especificaciones, solo listar las imprescindibles y que manejamos con seguridad. Jamás especificar algo que no sabemos de qué se trata (por más que lo veamos en los folletos y “nos parece” importante).
Por ejemplo, si necesitamos refrigerar una sala de equipos, en los requisitos se debe describirla, establecer el rango de temperaturas aceptable, y la zona de operación. Como especificación solo lo que estamos seguros de conocer bien y sean verdaderos limitantes como ser tensión de alimentación disponible, máximo tamaño disponible y si el acondicionador debe ser de mochila o Split.
Es muy importante insistir en la importancia de establecer los requisitos antes que especificar un producto determinado no dejando en claro lo que se necesita.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 11 de 14
Ingeniería hecha “después de la obra” tan solo para cumplir
Demás está decir que esto es una aberración y no sirve para nada útil, solo genera costos.
No confundir con el conforme a obra, dado que éste es un cambio de estado de una documentación que se realizó antes de la obra, se actualizó durante la obra y se le da un cierre definitivo luego de la obra. La utilidad del conforme a obra ocurre durante etapas de posventa, mantenimiento o futuras modificaciones. Los datos repetidos
Es bastante frecuente encontrar el mismo dato en varias partes de un documento y también en varios documentos. Esto que parece inocuo, termina siendo un verdadero dolor de cabeza cada vez que ese dato cambia. En los pliegos de licitaciones, este problema se repite hasta el hartazgo, y en general luego de varias revisiones un dato tiene múltiples valores posibles dentro del mismo pliego (ya que en general un nuevo pliego es un copiar-pegar de uno parecido).
Por ejemplo, si las dimensiones de una sala están en el plano de ubicación de equipos, no es necesario que estén en otro plano, como ser los frentes de rack, u otro donde no es necesario expresar esa medida. Lo mismo pasa en la redacción de memorias descriptivas o de funcionamiento, donde suele ocurrir con más frecuencia este problema. A veces al redactar se repite un dato (sin necesidad) y luego el día que se realiza una revisión se corren muchos riesgos de cometer errores.
Ejemplo: En alguna parte de la memoria descriptiva se establece que el inversor de un sistema fotovoltaico es de 1KW y hay uno solo. En el plano de ubicación de equipos se lo identifica como “inversor de 1K w” ¿era necesario decir que es de 1 KW, si hay de n solo tipo”, más adelante se establece que “el inversor de 1Kilo Watt” debe tener una distancia mínima de 30 cm respecto de otros equipos por razones de ventilación.
¿Qué pasa si cuando vamos a comprar los equipos descubrimos que ahora el proveedor nos entrega uno de 1.2 KW?. En esa situación hay que revisar todos los rincones de todos los documentos para revisionarlos, y encima quedan varios documentos revisionados por un solo cambio. También a priori uno pensaría que es fácil esta revisión ya que hoy en día todos los editores, tanto de texto como de planos, tienen la funcionalidad de encontrar-reemplazar. A propósito, en el ejemplo que usé puse 1KW en un caso, 1 K w en otro caso y 1Kilo Watt en el tercero, solo para ejemplificar lo complicado que es revisionar en estos casos. No queda más remedio que leer todo de vuelta y cambiar el dato repetido.
Recomendación: Siempre que sea posible debe evitarse que el mismo dato esté en más de una parte de un documento, así como también que este en distintos documentos.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 12 de 14
Las etapas de la documentación de ingeniería
La documentación de ingeniería tiene un único objetivo útil: SU USO
Para asegurarse que llega en condiciones adecuadas para ser usada en forma segura y con datos confiables, deben cumplirse pasos previos en etapas claramente diferenciadas. Cada empresa tiene su propio procedimiento y le puede asignar nombres distintos. No obstante eso, en la siguiente tabla se muestran los lineamientos generales y la secuencia recomendada para un uso exitoso de la documentación.
Una etapa en la que quiero hacer hincapié es la distribución. Es bastante habitual que las oficinas de ingeniería se desentiendan de lo que se hace con la documentación una vez elaborada y emitida.
Y después de la emisión viene la etapa más importante que es CUANDO LA DOCUMENTACIÓN SE USA.
Es bastante difusa la frontera entre la distribución y el uso y en general ambas actividades no se ejecutan en áreas de ingeniería. Los “usuarios” de la documentación técnica suelen ser sectores operativos, compras, los supervisores, etc. y son ellos quienes la distribuyen a quienes la necesitan. En ellos recae la responsabilidad de un uso cabal y eficiente de la mencionada documentación y que rinda sus frutos: que la ejecución del proyecto se realice con el menor costo posible “sacándole el jugo” a las horas invertidas en la elaboración de la documentación técnica.
Otro punto importante dentro del proceso de distribución es el de asegurarse que los destinatarios recibieron la información y la entendieron. No alcanza con “te mandé el plano”, el proceso completo es asegurarse que lo recibió y contiene la información que necesita. Algo así como cuando desde un control de tráfico aéreo se le dice a un piloto que use la pista 1 , el piloto debe contestar que está en camino a la pista 1, no alcanza con haberlo dicho y tampoco con que haya contestado: OK.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 13 de 14
En un informe, la conclusión primero
Si bien cada uno tiene su propia personalidad al momento de redactar, y cada uno elegirá la secuencia que crea mas adecuada para expresar algo, debemos tener en cuenta que un informe técnico no es un libro policial de suspenso. A veces se encuentran informes kilométricos donde se detalla todo el proceso de medición en el orden que se ejecutaron las mediciones, y luego de varias hojas (o peor aún en el medio del texto) se encuentra el resultado buscado: ensayo exitoso.
El lector se aburre luego de los primeros minutos o -peor aún- piensa que todo ese texto es solamente para ocultar una mentira y en algún lado encontrará un indicio de lo que no quería encontrar en ese informe.
Recomendación: primero la conclusión y luego el desarrollo. Eso predispone al lector del informe a leerlo mas distendido, y a veces a ni siquiera leer todo. En general en un informe de una medición, el desarrollo solo tiene propósitos documentales. Algo así como cuando el médico nos anticipa un “todo bien” y luego nos entrega 5 hojas de análisis con información que no entendemos.
Recomendaciones para elaborar documentación técnica
Ing Martín Lema abril de 2010
Página 14 de 14
