DOCUMENTACIÓN TÉCNICA
Todo proyecto necesita uno o varios documentos técnicos que describan su
estructura, procesos a llevar a cabo o especificaciones de cada una de sus partes.
Por este motivo en IDI S.L consideramos clave realizar una clara escritura,
organización y revisión técnica de la documentación con el objetivo de ayudar el
máximo posible a su destinatario.
INTRODUCCIÓN
Un documento técnico es aquel escrito que contiene información acerca de un área
de conocimiento, organizada de forma estructurada y presentada eficazmente a los
lectores. De manera muy sencilla podemos definir un documento técnico como todo
aquel documento que no es una obra literaria y que está relacionado con el ámbito
laboral, tecnológico o científico. Además, acompaña a todo proyecto como parte
fundamental del mismo.
Existen distintos tipos de documentación técnica asociada a cada etapa del proyecto:
informes, plano, manuales, listas de recambios, etc.
La documentación técnica consiste en toda la información que explica cómo funciona,
cómo se instala, cómo se atiende una instalación, un equipo, un sistema.
Los documentos técnicos deben cumplir con una serie de principios y de técnicas
para “mapear” la información, para estructurar bloques de información, para
etiquetarlos, para ilustrarlos y para utilizar la tipografía, por supuesto, también deben
seguir las reglas de escritura, como las ortográficas y el uso correcto de la sintaxis.
Para realizar un documento técnico de calidad, además de tener en cuenta sus
fundamentos, se requiere de una planeación cuidadosa, en la que se analice la
pertinencia de elaborar el documento, además de cómo, cuándo y en qué programa
realizarlo.
No cualquier documento, aun siendo un manual, un reporte o un apunte, es un
documento técnico eficiente si no cumple con los principios y las reglas precisas.
CARACTERÍSTICAS E IMPORTANCIA
Para escribir un buen documento técnico es preciso seguir una serie de reglas, cuya correcta
aplicación definirá la eficiencia que tenga al ser consultado por los destinatarios. Estas reglas no
se refieren solamente a aspectos estéticos o de inspiración del escritor, sino a reglas precisas y
estrictas para que, sin dejar a un lado un aspecto agradable a la vista o una organización y un uso
de recursos gráficos, el material logre su propósito primordial de presentar información concreta.
Al hacer este tipo de documentos, el reto es lograr que los destinatarios realmente los lean y
asimilen su contenido. Un documento bien elaborado debe invitar a la lectura. Un buen documento
es agradable al lector, aun cuando éste probablemente no sepa exactamente por qué es
agradable.
Para lograr este objetivo el documento debe:
Ser de fácil lectura.
Permitir al lector obtener el mayor provecho de su contenido.
Facilitar su actualización.
Proporcionar distintos niveles de detalle.
Al escribir un documento se deben seguir los siguientes teoremas:
1. Identificar a los destinatarios y escribir de manera apropiada para ellos.
2. Escribir con claridad.
3. Escribir de manera concisa.
4. Captar la atención de los destinatarios.
5. Ayudar al lector a la fácil comprensión.
Para lograr la armonía entre todos los teoremas habrá que dominar dos aspectos que
pueden parecer contradictorios:
Creatividad
Disciplina
Esto requiere tanto de conocer los fundamentos teóricos y experimentales de la buena
documentación técnica como de practicar, practicar y practicar.
TIPOS DE DOCUMENTACIÓN TÉCNICA
Existe gran variedad de documentos técnicos, con los cuales seguramente estás
familiarizado:
Correo electrónico
Mensajes instantáneos
Planos
Oficios
Documentación de software
Presentaciones
Circulares
Manuales de usuario
Manuales de organización
Páginas web
Apuntes
Libros de texto
Artículos científicos
Guías
Reportes
Instructivos
GESTIÓN DOCUMENTAL EN UNA INDUSTRIA
La cantidad de documentos que se generan en una empresa pasados unos meses
resulta abrumadora. Por ello es necesario poseer una estrategia de gestión
documental de la empresa. Procedimientos de trabajo, manuales internos, manuales
de equipos y de instalaciones, cualificaciones, validaciones, permisos, planos y un
largo etc. son generados constantemente e incorporados a la base de datos.
Una adecuada gestión de toda la información y documentación que la empresa posee
permitirá ser más eficiente y optimizar el trabajo.
El tener toda la documentación debidamente organizada y aplicando un buen
método de revisión técnica, agiliza sobremanera la búsqueda en un futuro de
cualquier archivo.
Está claro que, por un lado, destacamos la eficiencia y la rapidez a la hora de
almacenar y localizar documentos. Sin embargo, otro elemento importante es el
ahorro en recursos.
Hay que tener presente que la gestión documental puede hacerse tanto en papel
como de manera automática en un sistema informático. Sin embargo, ya es habitual
ver que la mayoría de empresas se organizan a través del empleo de
potentes sistemas de planificación de recursos empresariales (ERP, por sus siglas en
inglés, enterprise resource planning) donde almacenan, unifican y gestionan de
manera eficaz todos los datos y documentos de su empresa.
Ventajas de la gestión documental
Una buena gestión documental en la empresa, tiene toda una serie de ventajas:
Almacenamiento lógico y organizado de la documentación de cada uno de los
departamentos de la empresa.
Informatización de toda la información.
Ahorro en recursos: material, espacio y tiempo.
Incrementar la seguridad de los archivos, estando éstos bajo seguras claves a las
cuales tienen acceso unos pocos.
Almacenamiento en la nube, lo cual evita pérdidas de los archivos y deterioro de la
documentación.
Compartir la información con las personas que lo necesiten es más fácil que nunca.
Rápida localización de documentos, tengan la antigüedad que tengan. Al disponer
de un sistema de ordenación y organización lógico, encontraremos muy rápido
aquello que vayamos buscando.
Facilitar la actualización de la documentación.
