Agent Technical Writer
L'agent Technical Writer rédige ou met à jour la documentation utilisateur d'un changement. Il clôt Feature SDLC : son brouillon devient aussi le résumé de la session.
L'agent Technical Writer écrit pour les personnes qui utiliseront le changement. Il rédige une nouvelle documentation destinée aux utilisateurs, ou met à jour l'existante, afin qu'une fonctionnalité soit livrée avec une explication.
Où il intervient
| Workflow | Étape |
|---|---|
| Feature SDLC | User docs |
C'est la huitième et dernière étape de Feature SDLC. Il suit les étapes qui implémentent la fonctionnalité : il s'exécute donc une fois le code écrit et les tests du projet exécutés. À ce stade, la session dispose des exigences du Product Analyst, d'une conception technique de l'Architect, du changement côté serveur et côté client tel qu'il a été écrit, de scénarios de bout en bout et d'une revue de sécurité. Le rédacteur documente ce qui a réellement été construit.
Comme il s'exécute en dernier, sa sortie devient aussi le résumé de la session sur la page de la session, rédigé après l'exécution des tests.
Entrées
- La tâche de la session.
- Un instantané en lecture seule de fichiers du dépôt du projet, choisis pour leur pertinence par rapport à la tâche.
- Les sept étapes précédentes, sous forme abrégée pour tenir.
- Le changement tel qu'il a été écrit (un diff, coupé pour tenir, avec la coupure signalée lorsqu'il est long) et le résultat de test enregistré.
Sorties
Un brouillon de documentation sous forme de texte : nouvelles pages ou sections, modifications des pages existantes, et l'emplacement de chacune. Il est écrit pour les utilisateurs du produit, pas pour les ingénieurs qui l'ont construit.
Le code est déjà écrit lorsque cette étape s'exécute : le brouillon n'est donc pas transformé en fichiers dans la même session. Le diff ne contient de documentation que si la passe de code l'a écrite, par exemple parce que la tâche demandait un guide. Pour faire entrer le brouillon dans le dépôt, envoyez un prompt de suivi qui le demande sous forme de fichiers.
Exemple d'exécution
Exemple illustratif, pas une session enregistrée. Pour les préréglages de filtres, le Technical Writer ajoute une section « Vues enregistrées » au guide existant sur le filtrage. Il explique comment enregistrer les filtres en cours, appliquer une vue enregistrée et en supprimer une ; que les vues enregistrées sont personnelles ; et qu'il existe une limite de 20. Il ajoute une ligne au brouillon du changelog et note qu'une ancienne capture d'écran du guide sera obsolète une fois le bouton apparu.
Limites
- Il ne peut pas faire de captures d'écran ni vérifier l'apparence de la fonctionnalité.
- Il documente le changement à partir du diff qu'on lui montre, et un diff long est coupé pour tenir. Vérifiez le brouillon par rapport au diff complet.
- Son brouillon n'est pas écrit dans le changement. La documentation n'arrive dans la pull request que si la passe de code l'a écrite, ou par un prompt de suivi.
- L'agent Docs Writer, distinct, du catalogue de la console n'est utilisé aujourd'hui par aucun workflow intégré.
Questions fréquentes
La documentation qu'il rédige sera-t-elle dans la pull request ?
Pas depuis cette étape. Il s'exécute après l'écriture du code, son brouillon est donc du texte sur la page de la session. Le diff ne contient de documentation que si la passe de code l'a écrite, par exemple parce que la tâche demandait un guide. Pour ajouter le brouillon sous forme de fichiers, envoyez un prompt de suivi.
Peut-il suivre le style de notre documentation ?
Il lit les fichiers existants de votre dépôt, il a donc tendance à s'y conformer. Pour des règles plus strictes, remplacez ses instructions par un agent personnalisé nommé Technical Writer.