プロジェクト生きたドキュメント
NOC Living Docsを実行可能なプロジェクトメモリとして使用してください。noc_docs/ を経由し、影響を受けるドキュメントのみを読み、コードや意図が変更されたら生きたドキュメントを更新し、CLIで検証します。
トリガー
このスキルは以下の場合に使用します:
noc_docs/の初期化または移行- 要件について議論した後のコード変更
- 新機能、バグ修正、リファクタリング、API/データ/セキュリティ/デプロイメントの変更
- コード変更がドキュメント更新を必要とするかどうかの確認
- プロジェクトの生きたドキュメントのクエリまたは監査
プロジェクトメモリ、コード動作、要件、ガードレール、テスト、またはNOCドキュメントに関係のない一般的な質問には使用しないでください。
実行手順
- リクエスト、変更されたパス、および
noc_docs/.living-docs/feature-map.jsonから影響を受ける機能/ドメインを特定します。 - コードが変更される可能性がある場合、ワークプランを実行します:
python scripts/noc.py work /path/to/project --feature <feature> --intent "<合意された要件>"
機能名よりもパスが明確な場合は、--path <code/path> を使用します。
- 最小限の関連ドキュメントを読みます:
agent-guide.md、requirements.md、status.md、guardrails.md、test-record.md、およびドメイン固有のガードレール(存在する場合)。 - 確認された新しい/変更された意図を
requirements.mdに書き込みます。不確かな議論はnotes.mdに記録します。 - コードを変更します。
- 動作、検証、重要な変更、または制約が変更された場合、
status.md、test-record.md、change-record.md、guardrails.mdを更新します。 - ドキュメント、機能、またはマッピングが変更された後、
python scripts/noc.py index <project>を実行します。 - Gitが利用可能な場合、コミット前に
python scripts/noc.py check <project> --staged --warn-onlyを実行します。
詳細なワークフロールールについては、references/workflow.md を参照してください。
続行しない場合
以下の場合、コードを編集する前に停止してユーザーに確認します:
- リクエストが
guardrails.mdまたはドメインガードレールと矛盾する - 製品の意図が
requirements.mdと矛盾し、目的の方向性が不明確である - 影響を受ける機能/ドメインを特定できず、変更が明らかにグローバルではない
- 必要なドキュメントが欠落しており、タスクが未知の要件や制約に依存している
- ユーザーが現在のコードに合わせて要件を黙って書き換えるよう要求する
- 変更がセキュリティ、権限、課金、データ損失、移行、または公開API契約に影響し、要求された動作が曖昧である
完了条件
このスキルを使用したタスクは、以下の場合にのみ完了とします:
- 影響を受けるドキュメントが機能マップ、パス、または明示的な機能名を通じて特定された
- 必要なドキュメントが読まれたか、欠落しているドキュメントが指摘された
- コード変更とドキュメント変更が一致する
requirements.mdは意図された動作変更に対してのみ変更されたstatus.mdはコード変更後の現在の動作を反映しているtest-record.mdは検証を記録するか、検証が実行されなかった理由を説明しているchange-record.mdは重要な実装変更を記録している- インデックス/チェックが利用可能な場合は実行されたか、理由とともにスキップされた
最終応答形式
以下の形式で終了します:
NOC Living Docs:
- 確認したドキュメント:
- 更新したドキュメント:
- 意図的に変更しなかったドキュメント:
- 実行したコマンド:
- 実施したテスト:
- 残存リスク:
リストは簡潔に保ってください。該当しないカテゴリには なし を使用します。
参照
references/workflow.md: モード選択、フォールバックルール、競合処理、ワークループreferences/feature-doc-template.md: 各機能ドキュメントに含めるべき内容references/domain-mode-guide.md: ドメインモードの使用時期と方法references/codex-prompts.md: Codexの計画/目標/コードワークフロー向けの推奨ユーザープロンプト