Documentación del producto
Ayude a los usuarios a completar las tareas que permite su aplicación
Ofrezca a los usuarios guías prácticas que expliquen los recorridos de la aplicación y les ayuden a completar sus tareas.
Convierta las funcionalidades del producto en instrucciones prácticas
- Prepare el alcance de las guías
Revise las secciones de la documentación y su público previsto.
- Responda a las preguntas de contenido
Precise los flujos de trabajo y la información que debe explicar una guía.
- Siga el servicio público
Consulte el progreso de la construcción y la dirección del sitio de documentación.
Explique cómo utilizar la aplicación
La documentación completa la presentación de un producto con instrucciones prácticas. Empiece por los primeros pasos y después guíe a los usuarios por los flujos de trabajo que la aplicación admite realmente.
La configuración de la documentación muestra las definiciones de las secciones y las preguntas. Aporte un contexto que ayude a explicar una tarea en el lenguaje del usuario.
Mantenga la guía vinculada a la aplicación en funcionamiento
Respalde una primera acción útil. Una guía de primeros pasos ofrece a los nuevos usuarios un camino breve hacia el producto. Debe explicar por dónde empezar, qué información se requiere y qué resultado confirma que la tarea está completa.
Explique un flujo de trabajo recurrente. Una guía detallada sigue las etiquetas y las acciones reales de la aplicación. Los requisitos previos, los pasos numerados y un resultado esperado ayudan a repetir una tarea de negocio sin interpretar una descripción general de la pantalla.
Responda a una pregunta transversal. Algunas preguntas se refieren a cuentas, costes o publicación y no a una sola pantalla. Una FAQ ofrece una respuesta concisa y enlaza con la guía correspondiente, manteniendo el procedimiento en un solo lugar en lugar de duplicarlo por todo el sitio.
Mantenga las guías vinculadas al producto
Revise la documentación después de un cambio significativo en la aplicación. Una guía debe utilizar las etiquetas y el comportamiento que los usuarios pueden ver realmente.
La documentación funciona en su propio servicio público. Enlácela desde el sitio web y compruebe las guías en los idiomas que publica su proyecto.
Ayude a un usuario a completar la siguiente tarea
Una guía práctica explica por dónde empezar, qué información se necesita y cómo comprobar el resultado. Su valor reside en ayudar al lector a actuar en la aplicación.
Utilice guías relacionadas para continuar el recorrido cuando la tarea abarque varias áreas. Revise la documentación cuando cambie una pantalla para que las instrucciones sigan siendo útiles después de una evolución.
De la funcionalidad acordada a una ayuda útil
Prepare el alcance de las guías. Revise las secciones de la documentación y las tareas que deben explicar. Mantenga claros el usuario previsto y el comportamiento de la aplicación.
Aporte el contexto que falta. Responda a las preguntas sobre requisitos previos, reglas y resultados. La redacción debe utilizar la interfaz real en lugar de controles inventados.
Revise después de la publicación y de los cambios. Siga una guía en la aplicación, compruebe sus idiomas y los enlaces relacionados y vuelva a ella cuando cambie la tarea subyacente.
Haga que el producto sea más fácil de usar después de la primera visita
Ofrezca instrucciones que lleven a un resultado, junto con la presentación pública de lo que hace la aplicación.
Preguntas sobre la documentación del producto
Una página de funcionalidad ayuda a un posible cliente a entender la capacidad y su valor. Una guía ayuda a un usuario a realizar la tarea, con los controles reales, los requisitos previos y el resultado. Se complementan.
Las herramientas de documentación muestran las definiciones de las secciones y las preguntas. Revise las tareas que admite la aplicación, aporte el contexto que falta y siga el progreso de la redacción.
El proyecto publica las guías localizadas disponibles para su alcance. Revise cada idioma publicado para que conserve el procedimiento completo y las etiquetas correctas de la interfaz.
Después de un cambio que afecte a la tarea, a sus controles o al resultado esperado. Compruebe el texto frente a la aplicación en funcionamiento en lugar de suponer que las instrucciones originales siguen siendo válidas.
Una referencia de endpoints corresponde a un proyecto con una API activa y operativa. Utilice sus operaciones activas y su referencia real; las rutas previstas no bastan para documentar una integración utilizable.