Une documentation écrite avec le travail, pas après
Le manuel n’est jamais en retard sur vos spécifications
Sur votre code, il peut l’être : rien ici ne lit le code, donc une spécification construite autrement et toujours marquée terminée produit une page fausse. Ce que le manuel remarque, c’est une spécification qui a bougé.
Chaque page sait sur quoi elle a été écrite
Un rattachement conserve le contenu exact à partir duquel une page a été écrite : le blob SHA d’un document, la version d’un artifact. La fraîcheur compare ces valeurs, jamais une date.
- À jour
- Chaque rattachement correspond à sa source. Les lecteurs voient le nom des sources.
- Obsolète
- Une spécification rattachée a été marquée terminée dans une version plus récente, ou une source a changé. Les lecteurs voient laquelle et depuis quand, avant d’être induits en erreur.
- Source modifiée, pas encore construite
- Visible des éditeurs seulement. Une spécification modifiée lundi ne rend pas la page fausse avant que le travail existe.
- Toujours correcte
- Une personne confirme qu’une page obsolète est juste telle quelle. Les rattachements avancent, le texte reste et aucun crédit n’est dépensé.
Obsolète depuis que « Remboursements partiels » a été marqué terminé
- specs/payments/refunds.md
- specs/payments/partial-refunds.md
- adr/0007-idempotency-keys.md
L’agent qui a construit la fonctionnalité rédige la page
Votre propre agent de code rend compte de la réalisation via MCP et propose la modification du manuel dans le même rapport. Docs Flowy n’exécute aucun agent de code.
- 01Un agent rend compte de la réalisationAu départ, il apprend quelles pages sont rattachées à la spécification sur laquelle il travaille. À la fin, son rapport contient la page mise à jour, ou la raison pour laquelle aucun lecteur ne verrait de changement.
- 02La modification ouvre une demandePersonne ne modifie le manuel publié. Chaque modification, d’une personne ou d’un agent, est une demande de modification sur la version à partir de laquelle elle a été écrite.
- 03Une personne l’appliqueL’approbateur lit la modification et l’applique, ou la rejette avec un motif. Si une autre modification de la page est passée avant, celle-ci est dépassée et ne peut pas être appliquée en l’état.
Les agents peuvent proposer des modifications du manuel est un réglage du projet, activé par défaut. Un agent n’écrit que des pages Team : une revendication qui cite une page visible sur le site public est refusée.
L’assistant intégré ne rédige une page que lorsqu’une personne la demande dans la console, et il dépense les crédits de l’organisation.
Écrivez une fois dans Team. Organisez ce qui devient public.
Team
Chaque page est écrite, relue et approuvée ici. C’est le seul endroit où le contenu d’une page se modifie.
Public
Des entrées qui pointent vers des pages Team, dans les dossiers, l’ordre et les titres publics de votre choix. Le texte d’une entrée reflète sa page Team : rien ne dérive et personne ne modifie de copie.
Ce que comprend chaque forfait
- Le manuel d’équipe, avec des pages écrites à la main ou avec l’assistant
- Tous les forfaits
- Des pages qui deviennent dues quand une spécification est marquée terminée, et les demandes de modification des agents
- Starter et supérieurs
- Un site public pour le manuel
- Starter et supérieurs
L’assistant dépense des crédits sur tous les forfaits.
Écrivez la page pendant que le travail est frais
Connectez un repository, démarrez le manuel et rattachez sa première page à une spécification.
Commencer gratuitement