¿Escribir Ayuda Provechosa? Una Lista de comprobación Del Minimalism
La documentación del usuario es toda escrita demasiado a menudo por los programadores para los programadores. Tiende para centrarse en las características de producto, más bien que las tareas del usuario. Generalmente, los programadores no están en la posición ideal a ser documentación del usuario de la escritura. Están también cerca de los pedacitos y de los octetos, y están también lejos del usuario. A ellos, qué el producto puede hacer tiende para ser más importante lejano que qué el usuario puede hacer con el producto.
¿Es un sutil? ¿pero vital? distinción. La investigación demuestra que la llave a la documentación del usuario eficaz está escribiendo ayuda orientada a la función. Incluso mejore, escriba su ayuda según la teoría del minimalist. En el mundo de la documentación, el "minimalism" es una palabra de lujo para una práctica del commonsense. En términos básicos, significa escribe a su lector y lo mantiene simple.
La teoría sí mismo tiene muchos de torceduras y de vueltas. ¿Si usted desea leer un grande? ¿pero levemente wordy? reserve en el tema, cheque fuera del libro "minimalism más allá del embudo de Nurnberg", 1998, corregido por Juan Carroll.
En el medio tiempo, si usted puede hacer tictac cada artículo en la lista de comprobación siguiente, usted estará bien en su manera a la ayuda en línea usable para la cual sus lectores y sus encargados le agradecerán.
Lista de comprobación Provechosa De la Ayuda
1. Base la ayuda en tareas verdaderas (o ejemplos realistas)
2. ¿Estructure la ayuda basada en secuencia de tarea? Los títulos del capítulo deben ser metas y los asuntos deben ser tareas
3. ¿Respete la actividad del lector? éste es generalmente más sobre lo que usted no hace que qué usted lo hace. No pierda el tiempo del lector zambulliéndose apagado en tangentes
4. ¿Explote el conocimiento y la experiencia anteriores? Dibuje la atención del lector a las tareas, a las experiencias, a los éxitos, y a las faltas anteriores
5. Prevenga los errores - "asegúrele hacen x antes de hacer y"
6. Detecte e identifique los errores - "si esto falla, usted pudo haber entrado en la trayectoria incorrectamente"
7. Errores del arreglo - "vuelva a entrar la trayectoria"
8. Proporcione el error Info en el final de tareas cuando sea necesario (la regla del pulgar, una nota del error Info por tres tareas es un buen promedio)
9. No rompa para arriba las instrucciones con las notas, las precauciones, las advertencias, y los casos excepcionales - ponga estas cosas en el final de la instrucción, donde sea posible
10. Sea escrito, no explique todo, especialmente las cosas que se pueden tomar para concedido
11. Omita conceptual y observe la información en lo posible, o el acoplamiento a él. Quizás proporcione la información de la extensión en el final del asunto, más quizá una nota que hay otras maneras de realizar el task/goal, pero esto es el más fácil
12. Las secciones deben mirar cortocircuito y leer brevemente
13. Proporcione el encierro para las secciones (e.g., de nuevo a screen/goal original)
14. Proporcione una oportunidad inmediata de actuar y de animar la exploración y la innovación (las invitaciones activas del uso de actuar, por ejemplo, "consideran para se..." o "intente esto..." más bien que las invitaciones pasivas por ejemplo, "usted pueden...")
15. Consiga los usuarios comenzados rápidamente
16. Tenga en cuenta leer en cualquier orden - haga cada sección modular, especialmente metas, pero quizás tareas (definitivamente si pueden ser realizados en diversa orden)
17. Destaque las cosas que no son típicas
18. Utilice la voz activa más bien que la voz pasiva
19. Intente explicar el ambiente de usuario en su escritura
20. Antes de la escritura cualquier cosa, pregúntese que " esta ayuda mi lector?"
Construyendo estas prácticas en su proceso de la documentación, usted encontrará que su ayuda en línea llega a ser más fácil de escribir, más corto, y lejos más usable para su lector. ¡Cuál es más, su jefe le amará!
Sobre El Autor
* Glenn Murray es especialista de la sumisión del copywriter y del artículo de SEO. Él es director de PublishHub y también del estudio copywriting divino escriba. Él puede ser entrado en contacto con en Sydney +612 4334 6222 o en glenn@divinewrite.com. Visite http://www.divinewrite.com o http://www.publishhub.com para otros detalles, artículos MÁS LIBRES, o comprar su e-libro, los ' secretos de SEO.
Artículo Fuente: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster obtener el código html
Añadir este artículo a su sitio web ahora!
Webmaster Envíe sus artículos
No es necesario que se registre! Completa el formulario y su artículo está en el Messaggiamo.Com Directorio!
