Agente Technical Writer
El agente Technical Writer escribe o actualiza la documentación para usuarios de un cambio. Cierra Feature SDLC, así que su borrador también se convierte en el resumen de la sesión.
El agente Technical Writer escribe para las personas que van a usar el cambio. Redacta documentación nueva para usuarios, o actualiza la que existe, para que una funcionalidad se entregue con una explicación.
Dónde se ejecuta
| Flujo de trabajo | Paso |
|---|---|
| Feature SDLC | User docs |
Es el octavo y último paso de Feature SDLC. Sigue a los pasos que implementan la funcionalidad, así que se ejecuta cuando el código ya está escrito y las pruebas del proyecto ya se han ejecutado. Para entonces, la sesión tiene los requisitos del Product Analyst, un diseño técnico del Architect, el cambio de backend y de frontend tal como se escribió, escenarios de extremo a extremo y una revisión de seguridad. El redactor documenta lo que realmente se construyó.
Como se ejecuta el último, su salida también se convierte en el resumen de la sesión en la página de la sesión, escrito después de que se ejecutaran las pruebas.
Entradas
- La tarea de la sesión.
- Una instantánea de solo lectura de archivos del repositorio del proyecto, elegidos por su relevancia para la tarea.
- Los siete pasos anteriores, abreviados para que quepan.
- El cambio tal como se escribió (un diff, recortado para que quepa y con el recorte marcado cuando es largo) y el resultado de pruebas registrado.
Salidas
Un borrador de documentación en texto: páginas o secciones nuevas, cambios en las existentes y dónde va cada una. Está escrito para los usuarios del producto, no para los ingenieros que lo construyeron.
El código ya está escrito cuando se ejecuta este paso, así que el borrador no se convierte en archivos en la misma sesión. El diff contiene documentación solo si la escribió la pasada de código, por ejemplo porque la tarea pedía una guía. Para llevar el borrador al repositorio, envía un seguimiento que lo pida como archivos.
Ejemplo de ejecución
Ejemplo ilustrativo, no una sesión registrada. Para los filtros predefinidos, el Technical Writer añade una sección «Vistas guardadas» a la guía de filtrado existente. Explica cómo guardar los filtros actuales, aplicar una vista guardada y eliminarla; que las vistas guardadas son personales; y que hay un límite de 20. Añade una línea al borrador del registro de cambios y señala que una captura de pantalla antigua de la guía quedará desactualizada en cuanto aparezca el botón.
Límites
- No puede hacer capturas de pantalla ni comprobar el aspecto de la funcionalidad.
- Documenta el cambio a partir del diff que se le muestra, y un diff largo se recorta para que quepa. Contrasta el borrador con el diff completo.
- Su borrador no se escribe en el cambio. La documentación solo llega al pull request si la escribió la pasada de código, o mediante un seguimiento.
- El agente Docs Writer, que aparece por separado en el catálogo de la consola, no lo usa hoy ningún flujo de trabajo integrado.
Preguntas frecuentes
¿La documentación que redacta estará en el pull request?
No desde este paso. Se ejecuta después de que se escriba el código, así que su borrador es texto en la página de la sesión. El diff solo incluye documentación si la escribió la pasada de código, por ejemplo porque la tarea pedía una guía. Para añadir el borrador como archivos, envía un seguimiento.
¿Puede seguir el estilo de nuestra documentación?
Lee los archivos existentes de tu repositorio, así que tiende a ajustarse a ellos. Para reglas más estrictas, sustituye sus instrucciones con un agente personalizado llamado Technical Writer.