Recursos de escritura técnica

Esta página resume recursos adicionales de escritura técnica.

Guías de estilo editorial

Una guía de estilo editorial define las pautas de comunicación de un grupo editorial. Por ejemplo, ¿cuál de las siguientes reglas debería adoptar su organización para los títulos?

• Poner los títulos en mayúsculas (poner en mayúsculas sólo la primera palabra de cada título)
• Poner los títulos en mayúsculas (poner en mayúsculas la mayoría de las palabras de cada título)

No pierda tiempo y energía discutiendo sobre este tipo de cuestiones.Una guía de estilo editorial proporciona un conjunto de respuestas a las preguntas sobre las opciones de redacción. No importa que una guía de estilo editorial defienda las mayúsculas y minúsculas y otra prefiera las mayúsculas y minúsculas. Lo único que importa es que su organización adopte una única guía de estilo editorial.

¿Pero qué guía de estilo editorial? Puede que ya esté familiarizado con las guías de estilo editorial de uso general (como el Chicago Manual ofStyle o la University of Oxford StyleGuide).Sin embargo, su equipo de ingenieros debería utilizar una guía de estilo editorial especializada en escritura técnica. Recomendamos elegir una de las siguientes:

• La guía de estilo de la documentación para desarrolladores de Google proporciona directrices editoriales para cualquier persona que escriba documentación para desarrolladores en proyectos relacionados con Google.
• La guía de estilo de escritura de Microsoft proporciona directrices para cualquier persona que escriba documentación técnica.

No escriba su propia guía de estilo editorial. La creación y el mantenimiento de una guía de estilo editorial «de la casa» requiere enormes recursos y provoca enormes conflictos. Dicho esto, algunas organizaciones acuñan una nueva terminología que no aparece en una guía de estilo editorial existente. Cuando esto ocurre, la organización puede hacer una de las siguientes cosas:

• Pedir a los responsables del mantenimiento de una guía de estilo editorial que añadan los nuevos términos.
• Crear y mantener su propia guía de uso u hoja de estilo que codifique la ortografía y los usos de las palabras para el vocabulario especializado de su organización.

Oportunidades de documentación de código abierto