Consejos
El texto debería estar
organizado de manera que pueda leerse fácilmente, con las imágenes colocadas lo
más cerca posible al texto que haga referencia a ellas. Separa la documentación
en secciones y temas de manera lógica. Cada sección o tema debe abordar una
sola cuestión, ya sea una sola característica o tarea del programa. Los temas
relacionados pueden abordarse utilizando listados de “véase también” o
hipervínculos, en la medida que sea necesario.
Cualquiera de las
herramientas de documentación mencionadas antes pueden complementarse con un
programa que permita tomar capturas de pantalla, como Snagit, si la
documentación requiere algunas capturas de pantalla. Al igual que con otras
documentaciones, las capturas deben incluirse para ayudar a explicar cómo
funciona el programa, no para deslumbrar al usuario.
El tono es
particularmente importante, especialmente cuando se escribe documentación de
software para usuarios finales. Nombra al usuario utilizando la segunda persona
“tú” en vez de utilizar la tercera persona “los usuarios”.
Good work!
ResponderEliminarBien explicado.
ResponderEliminarCorto y bien hecho.
ResponderEliminarEstá bien pero podías haber hablado de la documentación en general en cualquier fase, o fase por fase. Pues creo que hablas solo de algunas fases.
ResponderEliminarHe intentado resumir y poner lo mas importante. Para más información, visita el enlace puesto al final de la entrada.
EliminarUn Saludo.
Bien resumido, muy claro
ResponderEliminarmuy bien resumido
ResponderEliminar