¿Cómo escribo un manual de operaciones?
Si tiene la tarea de escribir un manual de operaciones, debe tener acceso al equipo sobre el que escribirá. Cualquier persona con un buen dominio del inglés puede producir una buena documentación técnica si realiza los siguientes cinco pasos:
1. Análisis de audiencia front-end, Conozca el propósito y la audiencia para la documentación.
2. Investigue para proporcionar la información que satisfaga el propósito de la audiencia prevista. Esto debe incluir una foto o un dibujo de los interruptores, medidores e indicadores con leyendas y leyendas que describan el propósito de cada uno.
- ¿Cuándo uso propagate vs populate?
- ¿Por qué se usan metáforas y alusiones al escribir? ¿Hay alguna razón lingüística o psicológica?
- ¿Cuáles son los mejores concursos de poesía y escritura creativa que otorgan premios en efectivo?
- ¿Qué es exactamente un “efecto retórico”? ¿Cómo sucede?
- ¿Cómo desglosas largas piezas de escritura?
3. Organice la información y preséntela en una forma adecuada para el público destinatario. Comience con una tabla de contenido y un esquema.
4. Realizar pruebas de usabilidad. Use las instrucciones que ha escrito para determinar si ha cubierto la información necesaria de forma clara y concisa. Utilice a los participantes como muestra (s) representativa (s) de la audiencia de usuarios para probar más la documentación.
Monitoree y tome notas para determinar dónde funciona la documentación y dónde no funciona. Deje en claro a los participantes que la documentación se está probando y no a los participantes. No importa cuán bueno sea uno como comunicador técnico, las pruebas de usabilidad son la clave para determinar una buena documentación que funcione según lo previsto.
5. Revise la documentación hasta que funcione según lo previsto.
La documentación técnica puede verse bien, puede ser aprobada por gerentes que no son parte de aquellos que usarán la documentación y, sin embargo, la documentación no funciona según lo previsto. Esto significa que el departamento de capacitación o el servicio al cliente / técnico deben estar disponibles para resolver los problemas que podrían evitarse con una buena documentación.
Si se realizan los cinco pasos básicos anteriores, se puede crear una buena documentación técnica que funcione según lo previsto. Ver http://jamesgraves.com