Voy a darle el espíritu de habilidades de escritura técnica en lugar de darle una estructura para el manual primero.
Asegúrese de comprender su producto a fondo. Míralo desde la perspectiva del usuario final (posible cliente). ¿Podrían usarlo sin un manual? ¿Qué aspectos es probable que pierdan si no tuvieran un manual para referir? Juega con el producto tú mismo. Entrevistar a los creadores del producto es un gran punto a favor, pero asegúrese de tener varias entrevistas para que tenga una idea completa de todo lo que el producto puede / no puede hacer.
Un manual técnico debe ser como una historia, su comprensión de la perspectiva del cliente (¡Análisis de audiencia!) Será útil aquí. La información en el manual debe fluir en una secuencia lógica desde el inicio / inicio del producto hasta la configuración avanzada (si la hay).
Utilice tantas capturas de pantalla / gráficos como necesite, pero recuerde que demasiadas imágenes arruinarán su manual. Generalmente prefiero presentar primero el producto, enumerar las funciones básicas, enumerar las funciones avanzadas, etc. Recuerde finalizar el manual con Solución de problemas.
- ¿Cuál es la rutina de un escritor?
- ¿El ritmo de la prosa tiene un papel importante en la persuasión en estos días? Si es así, ¿qué tipo de ritmo de prosa?
- Cómo editar un documento de WORD 2010 (como aparecerá como un pdf) para su publicación en línea
- ¿Puedo seguir usando el síndrome de Asperger en mi historia?
- ¿Es normal cuando participa en un concurso de escritura y se reservan el derecho de usar su contenido?