Cinco consejos para Documentación Escritura Gran Técnica

La creación de documentación técnica es parte de hacer el trabajo en la industria de TI. Manuales técnicos, instrucciones de especificaciones técnicas, guías de apoyo, manuales de implementación - cada uno son los tipos de documentación técnica y son una parte del trabajo. Una gran cantidad de funciones técnicas en la industria de TI tomar parte en el proceso de documentación. Sólo podría parecer sencillo a sólo hay que poner algunas palabras y diagramas juntos, una tabla de contenidos y pensar en él como un documento técnico, pero y' Sa poco más que eso. I &'; he enumerado cinco siguientes consejos sobre cómo escribir grandes documentos técnicos

Tabla Estructurado-Bueno Uso Una de Contenidos

La tabla de contenido se encuentra entre la parte más importante de un documento.. La tabla de contenido enumera lo que es, de hecho, en el documento y la forma en que se dispone. Se utiliza para ayudar a los usuarios a entender que el documento proporciona la información que están buscando. Examinar la tabla de contenido, que son capaces de ver fácilmente si tiene lo que necesitan, o si tienen que leer otro documento.

Un beneficio adicional de tener una mesa bien estructurado de contenidos es que permite al lector para encontrar la información que necesitan rápidamente. Microsoft Word, Adobe PDF y también otras aplicaciones de documentos permiten hacer clic en enlaces de la tabla de contenido. Esto le permite hacer clic en el elemento o el número de página y que le llevará a la página. . Muy útil para encontrar temas rápidos

Sé sucinta pero completa

Al ser un autor del documento técnico, y' s difícil saber realmente qué cantidad y qué tipo de información para poner en este documento. Para escribir un gran documento, tratar de ser breve, pero completa. Lo que esto significa es no ir en y en y en todo tipo de detalles sobre ciertas áreas que no son necesarios por el lector. No es fácil decir qué y' s relevante y qué isn y' t - pero hacer un intento de considerar el lector y el público objetivo cuando y' re escribir el documento. Si usted es demasiado y" prolijo y" o utilizar demasiada información donde y' s innecesaria, se volverá a los lectores fuera y ganó y'. t ser un documento eficaz

Ser coherente en todo el documento

La consistencia es una manera importante a mejorar un documento. Esto hará que se vea más profesional, y, en realidad, más legible para el usuario. Cuando digo coherencia, me refiero a la regularidad tanto en la jerga que utiliza y el formato están aplicando. Algunos individuos ganó y' t notar esto. Sin embargo, si usted y' re componer un documento técnico, y' s más que probable que para otros usuarios técnicos, que son por lo general la gente detalle centrada. Asegúrese de que el documento se utiliza el mismo formato en todas partes. Trata de romper los datos y hacer que sea comprensible para los usuarios por la utilización de los espacios en blanco de manera efectiva.

También se recomienda el uso de las mismas expresiones. Esto probablemente se asegurará de que el usuario que sabe y' re escribir sobre lo mismo mediante el uso de las mismas palabras. Si usted utiliza las palabras de manera intercambiable, por ejemplo y" escritorio y " ;, “ PC y " ;, “ equipo &" ;, que podría confundir al usuario, cuando en realidad se refiere a la misma cosa. Ese y' sa ejemplo rápido, pero la idea es que usted debe elegir el plazo de un y permanecer con él

que sea exacta y sin errores

Casi no hace falta decir que la documentación técnica realmente. debe ser libre de errores. Como he dicho anteriormente, un buen número de lectores del documento serán otros usuarios técnicos, y allí y' sa muy buena posibilidad de que los errores se destacan a ellos. Además de eso, si los errores don &'; t saltar, entonces se les proporciona la información incorrecta sobre el sistema o el área que usted y'! Re documentar - que contradice el objetivo del documento

Evite pantalla grande Captura

Haciendo uso de capturas de pantalla o imágenes dentro de su documentación es definitivamente una manera eficaz de explicar su punto para el lector. It &'; s principalmente útil para la documentación del software o soporte los procesos, que son fáciles de tomar capturas de pantalla de. Sin embargo, las pantallas de ordenador han vuelto más grande en los últimos años, pero hojas A4 han sido siempre del mismo tamaño.

Esto deja una inclinación a incorporar grandes capturas de pantalla en un documento, lo que hace que las capturas de pantalla pequeña e ineficaz. Incluyendo capturas de pantalla es una gran idea - don &'; t me malinterpreten - pero hacer un esfuerzo para incluir sólo las áreas que se relacionan con la sección que y' re explicar. Esto tiende a conducir a más capturas de pantalla, sin embargo, serán más eficaces y hacer el documento más legible Hotel  .;