Los escritores técnicos crean diferentes tipos de documentación, por ejemplo, manuales de usuario, documentación de la API, guías ‘How to’, etc. Escribí un artículo sobre cómo escribir un manual de usuario, así que hoy te hablaré de cómo crear una guía ‘How to’.
Cuando recibes una tarea para crear una guía tu primer paso debe ser la planificación. Esto es lo que debes hacer:
Entender a tu público objetivo
Cuando empieces a escribir tu guía, debes entender claramente quién es tu público objetivo. Cuál es su edad, cuál es su formación, etc. Esto definirá el estilo de tu guía «Cómo hacer» en el nivel más fundamental: la complejidad del lenguaje utilizado, el número de términos y muchas otras características.
Investiga sobre el proceso
Te recomiendo que leas sobre la experiencia de otras personas al escribir guías «Cómo hacer». Te ayudará a tener una imagen clara del trabajo futuro, y podrás integrar los enfoques de otros en tu proceso de trabajo. Por ejemplo, escribí sobre el proceso de escritura técnica de Amrute Ranade, puedes leer el artículo aquí: ‘Great Technical Writing Process’. Así que también puedes utilizar este método para facilitar tu escritura técnica.
Reúne materiales útiles
Antes de empezar a escribir, recopila material e información que te ayude a escribir una guía de «cómo hacerlo». Puede ser información adicional sobre un producto, otras guías de «cómo hacerlo» sobre productos similares o cualquier otra cosa.
Escribe tu guía de «cómo hacerlo»
En primer lugar, crea un plan: será más fácil escribir una guía si la visualizas. Después de todos estos preparativos, es el momento de empezar a escribir. Mientras crea una guía, debe tener en cuenta los siguientes consejos:
- Escriba en inglés sencillo para hablar el mismo idioma que sus lectores.
- Su lenguaje debe ser siempre conciso (por ejemplo,
- Su lenguaje debe ser siempre conciso (por ejemplo, «Seleccione la opción» en lugar de «Debe seleccionar la opción»).
- Cree listas numeradas para estructurar los pasos si un usuario necesita completarlos
- Agregue contenido visual como fotos, capturas de pantalla y diagramas.
- Divida el contenido en secciones encabezadas, pero escríbalas con claridad
- Si quiere utilizar chistes, tenga cuidado: la gente puede no entenderle
- Añada mini-TOCs para hacer más legibles los temas grandes.
El consejo más esencial es el siguiente: los errores ortográficos y gramaticales son inaceptables en la documentación, así que revise a fondo su guía. Aquí hay una lista de los mejores correctores gramaticales gratuitos. Además, puedes pedir a otra persona que corrija por ti, o leer tus propios pasos al revés para asegurarte de que tu escritura es clara y sencilla. Aquí hay un par de otros recursos para escribir una gran documentación:
- Libros de gramática para escritores técnicos
- Guías de estilo para escritores técnicos
Por supuesto, eso no es todo lo que hay que saber sobre la escritura de guías de ‘Cómo’, pero estos consejos son los más esenciales, en mi opinión. Espero que te sirvan de ayuda.
¡Buena suerte con tus guías de escritura!