Cómo escribir documentación técnica
comunicación técnica o la documentación es el proceso de transmisión de información "fácil de usar" a través de la escritura sobre un tema en particular, a un público objetivo. documentación técnica varía de un correo electrónico de negocio a los informes de negocio a un sistema de guía de usuario o la ayuda. Muchos sólo recurrir a la documentación # X201C-cuando todo lo demás falla. # X201D- No es de extrañar la documentación es a menudo mala calidad en el mejor- inexistente en el peor. Las empresas de informática pueden sentir que su software es tan fácil, que don # x2019-t necesidad de documentación. Sin embargo, la documentación técnica es menos costosa que las llamadas de soporte técnico. Antes de poder desarrollar una buena documentación técnica, lo que necesita saber que la documentación técnica eficaz es una misión bien planeada y ejecutada.
Contenido
Cosas que necesitará
- Computadora
- herramienta de autoría
- Experto en la materia
Determinar el propósito y la audiencia. Es necesario saber por qué se está creando esta documentación y que se va a leer. El tipo de documentación se crea será diferente si su público es un mecánico de automóviles que si su audiencia es un ingeniero de software.
Video: Curso de Elaboración de la Documentación Técnica
Video: El trabajo de Campo y la Documentación en un Proyecto de Investigación
Recopilar información. La persona que crea la documentación es a menudo un escritor y no el experto en la materia. Es importante recopilar la información para que pueda documentarlo. La recogida de la información puede significar hacer la investigación, entrevistando a un experto en la materia, o experimentar con el producto en sí, como en el caso de un programa de software.
Organizar y describir la información. Usted puede comenzar con un documento existente o una plantilla. Es # x2019-s importante introducir la información que usted tiene y dejar en blanco las áreas donde se necesita reunir más información. Esta será su documento de trabajo, y usted va a construir en él. Anotar lo que tienen, incluso si tiene grandes extensiones de espacio vacío aumentará su confianza en que se está moviendo hacia adelante en el proyecto.
Video: Webinar - Cómo crear documentación técnica fácilmente
Escribir el primer borrador. Esto es cuando se empieza a llenar los espacios en blanco y permitiendo un flujo de ideas a transmitir desde su conciencia. No deje de que el flujo mediante la revisión en esta etapa.
Revisar y editar. Es posible que desee colocar el documento fuera por un período de tiempo para que pueda darle un aspecto fresco. A continuación, se centran en temas que necesitan más atención- acortar, ampliar o eliminar secciones- o reorganizar los párrafos, oraciones, o temas enteros. También tendrá que editar el estilo, la gramática y el contexto.
Consejos advertencias
- Una lista de control de edición es muy útil para que pueda editar para diferentes puntos durante pasadas separadas.
- Desarrollar buenas habilidades de jugador de equipo y una comprensión de cómo cada uno experto en la materia prefiere trabajar para mantener esta relación se convierta contradictorio.