1. Para escribir un buen documento técnico es preciso seguir una serie de reglas
1.1. • Ser de fácil lectura. • Permitir al lector obtener el mayor provecho de su contenido. • Facilitar su actualización. • Proporcionar distintos niveles de detalle.
2. Conceptualización de documentación técnica
2.1. 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.
3. Al escribir un documento se deben seguir los siguientes teoremas:
3.1. 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.
4. La documentación técnica no se basa en una escritura tradicional, sino en forma de organizar y presentar la información según resultados de pruebas experimentales, en cuanto a la comunicación clara.
5.1. • Correo electrónico • Mensajes instantáneos • Oficios • Documentación de software • Presentaciones por computadora • Circulares • Manuales de usuario • Manuales de organización • Páginas web • Apuntes • Libros de texto • Artículos científicos • Guías • Reportes • Instructivos
6. Un buen escrito deberá lograr un equilibrio armónico entre todos los teoremas :
6.1. • Creatividad • Disciplina
7. Los documentos técnicos pueden dividirse según su estilo, forma de presentación y de distribución
7.1. Para realizar un documento técnico de calidad, además de tomar 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.
