escribir lista de verificación, escribir para la web

escribir lista de verificación, escribir para la web


Artículo del cuerpo:
La documentación de usuario es con demasiada frecuencia, escrito por programadores para programadores. Tiende a centrarse en las características del producto, en lugar de tareas del usuario. En general, los programadores no están en la posición ideal para escribir la documentación de usuario. Están demasiado cerca de los bits y bytes, y están demasiado lejos del usuario. Para ellos, lo que puede hacer el producto tiende a ser mucho más importante que lo que el usuario puede hacer con el producto.

Es una sutil - pero vital - la distinción. Las investigaciones muestran que la documentación de usuario clave de una eficaz tarea de ayudar a escribir es orientado. Mejor aún, escriba su ayuda, según la teoría minimalista. En la documentación mundo, el "minimalismo" es una palabra de lujo para una práctica común. En términos básicos, que significa escribir en su lector y mantenerlo simple.

La teoría en sí tiene un montón de vueltas y revueltas. Si quieres leer una gran - pero poco prolijo - libro sobre el tema, echa un vistazo a el libro "Más allá de la minimalismo Nurnberg Embudo", 1998, editado por John Carroll.

Mientras tanto, si usted puede marcar cada artículo en la siguiente lista, usted estará bien en su manera a la ayuda en línea utilizable que tanto sus lectores y sus directivos se lo agradecerán.

Lista de útiles Ayuda

1. Base de la ayuda en tareas reales (o ejemplos reales)

2. Estructura de la ayuda sobre la base de secuencia de tareas - títulos de los capítulos deberían ser objetivos y los temas deben ser tareas

3. El respeto de la actividad del lector - que generalmente es más sobre lo que no hacer que lo que haces. No pierda el tiempo del lector por fuera de zambullirse en las tangentes

4. Aprovechar los conocimientos y experiencias anteriores - Sorteo del lector atención a las tareas anteriores, las experiencias, éxitos y fracasos

5. Prevenir errores - "Asegúrese de hacer x antes de hacer y"

6. Detectar e identificar errores - "Si esto falla, puede haber entrado en el camino incorrecto"

7. errores Fix - "Re-introduzca la ruta"

8. Proporcionar información de error al final de las tareas cuando sea necesario (regla de oro, una nota de información de error por tres tareas es un buen promedio)

9. No rompa las instrucciones con las notas, precauciones, advertencias, y los casos excepcionales - Poner estas cosas al final de la instrucción, siempre que sea posible

10. Sea breve, no hechizo todo hacia fuera, sobre todo cosas que se pueden dar por sentado