Crear documentación

La documentación es parte del ciclo de flujo de trabajo. Crear documentación no es un trabajo fácil. Aquí hay algunos consejos que puede hacer para hacer la documentación de su trabajo.

1. Incluir imagen
Use la imagen como texto complementario para minimizar la longitud y complejidad de su documento. El sistema de usuario adora ver imágenes, diagramas, tablas y listas en forma de viñetas para una referencia rápida.

2. Dé ejemplos
Los ejemplos son la forma apropiada para que los usuarios finales aprendan un nuevo software para que sea más fácil de entender.

3. No haga suposiciones
En el momento de la documentación, colóquese como un nuevo usuario. La documentación debe estar escrita de tal manera, instrucciones paso a paso y colocada en el apéndice, un capítulo separado, para que no se vea desordenada.

4. Anticípese a los problemas
Documente cómo superar el problema y bríndelo a los usuarios y al servicio de asistencia. Documente los eventos que a veces ocurren durante el uso del sistema. La documentación que cree debe ser para anticipar problemas y proporcionar planes detallados e instrucciones para la recuperación del sistema.

5. Revise la documentación
Tómese el tiempo para revisar su documentación. La primera revisión toma el tema de “macro”, como estructura, estilo; la segunda revisión aborda el tema de “micro” es más específico en cuanto al tema de una subsección.

6. Humanize Documentation
Haga su documentación para que el lector se sienta más cómodo a la hora de leerla.

7. Exploración de nuevas tecnologías
Uso de nuevas tecnologías en la documentación de fabricación para reducir costos y mejorar la efectividad.

8. Cree su propia documentación si lo permite
Si está creando un sistema, cree su propia documentación para su sistema porque sabe mejor sobre el sistema que creó.

9. Documentación de sincronización
Puede reducir el tiempo de la documentación si realiza la Documentación del usuario final con la Documentación del sistema. Puede intercambiar información entre ellos y reducir la información que falta.

10. Siga la Guía de documentación estándar
Cree y siga las pautas de formato estándar. Esto ayudará a garantizar que no falte información importante que facilite la lectura por parte del usuario.

Dejar respuesta

Please enter your comment!
Please enter your name here