Documentation Vivante du Projet
Utilisez NOC Living Docs comme mémoire exécutable du projet. Acheminez via noc_docs/, lisez uniquement les documents affectés, mettez à jour la documentation vivante lorsque le code ou l'intention change, puis vérifiez avec l'interface CLI.
Déclencheur
Utilisez cette compétence pour :
- initialiser ou migrer
noc_docs/ - discuter d'une exigence puis modifier du code
- nouvelles fonctionnalités, corrections de bugs, refontes, modifications d'API/données/sécurité/déploiement
- vérifier si les modifications de code nécessitent des mises à jour de la documentation
- interroger ou auditer la documentation vivante du projet
Ne l'utilisez pas pour des questions générales qui n'impliquent pas la mémoire du projet, le comportement du code, les exigences, les garde-fous, les tests ou la documentation NOC.
Exécution
- Identifiez la fonctionnalité/domaine affecté à partir de la demande, des chemins modifiés et de
noc_docs/.living-docs/feature-map.json. - Exécutez un plan de travail lorsque le code peut changer :
python scripts/noc.py work /chemin/vers/projet --feature <fonctionnalité> --intent "<exigence convenue>"
Utilisez --path <chemin/code> lorsque les chemins sont plus clairs que les noms de fonctionnalités.
- Lisez les plus petits documents pertinents :
agent-guide.md,requirements.md,status.md,guardrails.md,test-record.md, plus les garde-fous de domaine lorsqu'ils sont présents. - Écrivez les nouvelles intentions confirmées/modifiées dans
requirements.md; placez les discussions incertaines dansnotes.md. - Modifiez le code.
- Mettez à jour
status.md,test-record.md,change-record.mdetguardrails.mdlorsque le comportement, la vérification, les modifications importantes ou les contraintes ont changé. - Exécutez
python scripts/noc.py index <projet>après les modifications de documentation, de fonctionnalité ou de mappage. - Exécutez
python scripts/noc.py check <projet> --staged --warn-onlyavant le commit lorsque Git est disponible.
Pour des règles de workflow détaillées, lisez references/workflow.md.
Ne Pas Procéder
Arrêtez-vous et demandez à l'utilisateur avant de modifier le code lorsque :
- la demande entre en conflit avec
guardrails.mdou les garde-fous de domaine - l'intention du produit entre en conflit avec
requirements.mdet la direction visée n'est pas claire - la fonctionnalité/domaine affecté ne peut pas être identifié et la modification n'est pas évidemment globale
- les documents requis sont manquants et la tâche dépend d'exigences ou de contraintes inconnues
- l'utilisateur demande de réécrire silencieusement les exigences pour correspondre au code actuel
- la modification touche la sécurité, les permissions, la facturation, la perte de données, les migrations ou les contrats d'API publique et le comportement demandé est ambigu
Définition de Fait
Une tâche utilisant cette compétence n'est terminée que lorsque :
- les documents affectés ont été identifiés via la carte des fonctionnalités, les chemins ou le nom de fonctionnalité explicite
- les documents requis ont été lus ou les documents manquants ont été signalés
- les modifications de code et les modifications de documentation concordent
requirements.mda été modifié uniquement pour des changements de comportement intentionnelsstatus.mdreflète le comportement actuel après les modifications de codetest-record.mdenregistre la vérification ou explique pourquoi la vérification n'a pas été exécutéechange-record.mdenregistre les modifications d'implémentation importantes- les indexations/vérifications ont été exécutées lorsque disponibles, ou ignorées avec une raison
Format de Réponse Finale
Terminez par :
NOC Living Docs :
- docs vérifiés :
- docs mis à jour :
- docs intentionnellement inchangés :
- commandes exécutées :
- tests exécutés :
- risques restants :
Gardez les listes courtes. Utilisez aucun lorsqu'une catégorie ne s'applique pas.
Références
references/workflow.md: sélection de mode, règles de repli, gestion des conflits, boucle de travailreferences/feature-doc-template.md: ce que chaque document de fonctionnalité doit contenirreferences/domain-mode-guide.md: quand et comment utiliser le mode domainereferences/codex-prompts.md: invites utilisateur recommandées pour les workflows Codex plan/objectif/code