Estructura de oraciones: Como con cualquier otro tipo de escritura, la escritura técnica debe seguir las reglas estándar de la gramática y la estructura de la oración. Sin embargo, con la escritura técnica no le pagan por la cantidad de palabras. Al escribir documentos técnicos, menos palabras son mejores. El bloque básico de construcción de toda la escritura (después de las opciones de palabras) es la estructura de la oración.
Recuerda estos hechos mientras escribe manuales técnicos: 1) Use una estructura de oración simple. 2) Las oraciones cortas hacen que un documento sea más legible. 3) Si una oración contiene más de 25 palabras, reescribe en dos o más oraciones. 4) Use verbos activos y tiempo presente. 5) Use palabras específicas y concisas. 6) No use palabras innecesarias. 7) Haz tu significado simple y claro. 8) Sea consistente. Use palabras de la misma manera cada vez que se usan. 8) Use listas de balas generalmente.
Las oraciones simples cortas que usan inglés simplificado son más fáciles de traducir a otros idiomas.
Regla #1: Las oraciones deben ser no más de un máximo de 25 palabras, con una longitud preferida de 20 palabras o menos.
Estructura del párrafo: Recuerde estas pautas de estructura del párrafo mientras escribe: 1) Cada párrafo debe abordar solo un sujeto. 2) La primera oración debe indicar el tema del párrafo. 3) Todas las oraciones en un párrafo deben relacionarse con el sujeto. 4) Los párrafos cortos son los mejores. 5) Los lectores pueden perderse en párrafos largos.
Usar un juicio razonable con respecto a la longitud del párrafo. A veces es posible que necesite dividir un párrafo perfectamente bueno en dos párrafos simplemente porque es demasiado largo. Si se pierde en la longitud, su lector también puede.
En la escritura técnica, no se prefieren los párrafos de una oración, sino que son aceptables. Un párrafo de una oración es mejor que un párrafo de divagación que contiene material no relacionado.
Las transiciones de párrafo deberían ser naturales tanto dentro de un párrafo como entre párrafos. Tenga en cuenta el tema del párrafo en todo momento. Tenga en cuenta el tema general del documento en todo momento.
Estructura del documento: Organice su material en una secuencia lógica. Aunque hay varias formas de organizar el material, una de las formas más fáciles es proporcionar primero información general de descripción general, luego continúe con información detallada específica.
Muchos documentos técnicos se refieren tanto a ensamblajes y subconsembles que son combinado para crear un sistema completo. Proporcionando una visión general de todo el sistema, luego cada ensamblaje principal, seguido de cada uno de los subconjuntos asociados llevará al lector a una mejor comprensión del sistema general. Cuando sea apropiado, consulte cada elemento del sistema por su identificación, con bastante frecuencia es un designador alfabético, numérico o alfa-numérico.
Terminología: Siempre use la terminología de manera consistente. Por ejemplo, si el usuario debe realizar la misma acción más de una vez, use la misma redacción cada vez que se refiera a la acción específica. Siempre use el mismo término o palabra para referirse al mismo tipo de concepto, operación o tema.
En otros tipos de escritura, la variedad puede hacer que el tema sea más interesante. Cuando se trata de escritura técnica, la variedad a menudo conduce a lectores confusos. El acrónimo Kis (Keep It Simple) siempre es apropiado para la documentación técnica.
Precisión del documento: La información precisa y precisa es esencial en la escritura técnica. La documentación inexacta causará clientes insatisfechos. Las instrucciones inexactas pueden ser mortales.
Para garantizar que su documentación sea precisa, un escritor técnico debe hacer lo siguiente: 1) Manténgase actualizado sobre los cambios en el producto. 2) Consulte con expertos en la materia (PYME). 3) Validar los procedimientos y descripciones del equipo. 4) Requiere la (s) revisión y la sesión de firmación de las PYME en toda la documentación antes de la publicación.
