Reglas Generales de documentación

Aunque parece de perogrullo decirlo, nunca está de más recordar que todo documento debe cumplir ciertas Reglas Generales. Éstas se pueden catalogar como:


Las Reglas de Estilo señalan que todo documento formal debe ser escrito en tercera persona, es decir, nunca se debe hacer referencia a "nosotros", "yo", etc. sólo en casos muy excepcionales, se podría llegar a utilizar el "Usted". Además se debe hacer referencia a los cargos, y sólo en forma muy ocasional, a los nombres propios de las personas o instituciones (algo similar a lo que ocurre en los contratos, donde las partes son identificadas al inicio y se les asigna un "alias" a utilizar en el resto del documento, típicamente: En adelante, "La Empresa"). Por otra parte, se debe mantener un lenguaje y redacción acorde a la situación, evitando expresiones de tipo localistas o costumbristas, es decir no pegarse la volá, ni descubrir que el Cliente no cacha de que está hablando.

Las Reglas de Forma nos recuerdan que al inicio de todo documento, se debe incluir una Introducción, en la que se relaten, en forma breve, los eventos que llevaron a la generación documento, además entregue una descripción general de los objetivos y contenidos de éste y explique cual es el problema a tratar. En algunos casos, a continuación de la Introducción, se debe agregar un Marco Teórico, en el cual se explican cuales fueron las metodologías y/o procedimientos utilizados para construir el documento del caso. Finalmente, es menester agregar al documento las Conclusiones que de él se obtienen, y las recomendaciones o sugerencias para el trabajo que siga luego de entregado el presente documento La principal de las conclusiones, siempre es la evaluación del grado de cumplimiento de los objetivos trazados en la Introducción.

La Reglas de Construcción se refieren a que todo documento debe ser construido en función de la información que se ha recopilado, analizado, estudiado y, de ser necesario, cotejado con otras fuentes. Es una muy mala política, para un trabajo de Ingeniería, la de transcribir una entrevista, cuestionario o formulario, tal y como lo respondió el usuario. En segundo término, se debe tener presente que hay que buscar la información en su origen, es decir, no se debe aceptar como valedero algo que se sabe de "oidas"... A menos que sea imposible recurrir a la fuente original, y el cliente asuma la responsabilidad de la veracidad y completitud de la información entregada.

Las Reglas de Fondo, son en su esencia, la consideración ética que todo trabajo profesional debe respetar y respaldar. Algunas de las ideas asociadas (pero muy a menudo olvidadas) son:

El resumen de estas reglas es: "No hay ninguna razón valedera, para hacer mal un trabajo".


perogrullo:
Definición "obvia" supuestamente conocida por todos, pero que de todas maneras se hace para prevenir errores: "aunque parezca de perogrullo, nunca está demás definir la palabra perogrullo"...