Cómo reducir los errores de documentación y omisiones

La documentación es a menudo primer recurso de un usuario cuando la solución de problemas de software, y una buena documentación debe presentar la información de una manera clara y comprensible, que también es fácil para los usuarios encontrar. El tiempo dedicado a la revisión de la documentación para encontrar errores y omisiones en los resultados de un producto aparentemente más profesional y reducir significativamente los costos de apoyo al responder preguntas de los usuarios.

Instrucciones

Un análisis de la documentación para reducir los errores y omisiones

1 Tómese el tiempo para averiguar las preguntas que sus usuarios tienen más probabilidades de ocurrir. A menudo, estos se pueden encontrar en los foros de discusión para las versiones anteriores del producto o para productos similares.

2 Utilice la documentación para instalar y desinstalar el producto, siguiendo solamente las instrucciones incluidas en la documentación. Si usted se encuentra tomando medidas que no se detallan en la documentación existente, esos pasos deben agregarse.

3 Leer a través de la documentación de principio a fin, en busca de puntos que no están claros o por error.

4 ejemplos de código se ejecutan a través del producto para asegurarse de que funcionan de la forma en que se describen en el producto.

5 Siempre que sea posible, comparar las capturas en la documentación de las pantallas reales. A menudo, los cambios de interfaz de usuario se realizan en el último momento, pero no documentados por completo.

6 Pedir a los usuarios que no están familiarizados con el producto para instalarlo y ejecutarlo, utilizando únicamente la documentación. Observarlos para ver qué preguntas se plantea que no están incluidos en la documentación o son difíciles de encontrar.