Hay muchas fuentes para escribir guías de estilo, pero aquí están los conceptos básicos que suelo seguir:
- Tiempo : mantenga su documento en tiempo actual donde sea posible. Tenga cuidado de no pasar a un vocabulario en tiempo pasado o futuro a menos que esté expresando específicamente algo que sucedió en el pasado o algo que espera ver en el futuro. Ejemplo:
- Tiempo actual: Nuestros hallazgos muestran …
- Tiempo pasado: nuestros hallazgos mostraron …
- Objetividad : la mayoría de los documentos técnicos deben evitar la subjetividad, como las opiniones personales. Ejemplo:
- Objetivo: Los resultados muestran que el producto puede soportar hasta 180 grados Fahrenheit.
- Subjetivo: Creemos que la temperatura nominal del producto será de aproximadamente 150 a 190 grados Fahrenheit.
- Voz : ¿Quién está escribiendo el artículo y quién lo está leyendo? Deberá pensar en esto para determinar la voz adecuada. Como la mayoría de los documentos técnicos, escribirás algo al principio como: Este artículo representa los hallazgos del siguiente equipo de personas … en adelante denominado “nosotros”. Además, decida cómo va a hablar con el lector. Por lo general, se refieren al lector como “usted”. Ejemplos:
- Bien: presentamos nuestros hallazgos desde enero de 2015 hasta noviembre de 2015. Le presentamos este artículo en enero de 2016.
- Malo: presentamos nuestros hallazgos desde enero de 2015 hasta el 15 de noviembre. Presento mis hallazgos a todos los que lean esto en enero de 2016.
- Cuente una historia : el hecho de que esté escribiendo un artículo técnico no significa que no deba contar una historia. Por ejemplo, este es un ejemplo de un buen esquema.
- Lista de personas responsables del documento.
- Referencias históricas que conducen al documento.
- Objetivos del documento (qué está adentro, qué está afuera).
- Métodos utilizados para extraer las conclusiones del documento.
- Resultados finales de los hallazgos.
Espero que esto ayude.