# flow-docs-templates > フロー単体の要件定義・進捗ログ・ノード仕様書・運用テストガイド用テンプレートを提供します。フロー要件定義テンプレート(基本情報・機能要件・非機能要件・外部連携/設定・受入基準・メモ/課題)、進捗ログテンプレート、ノード仕様書テンプレート(ノード一覧・変数・設定)、運用テストガイドテンプレート(運用手順・テストケース・トラブルシューティング)を標準化し、フロー開発の品質と一貫性を保証します。 - Author: ryuseisuda - Repository: ryuseisuda/clawd2 - Version: 20260123002259 - Stars: 0 - Forks: 0 - Last Updated: 2026-02-06 - Source: https://github.com/ryuseisuda/clawd2 - Web: https://mule.run/skillshub/@@ryuseisuda/clawd2~flow-docs-templates:20260123002259 --- --- name: flow-docs-templates description: "フロー単体の要件定義・進捗ログ・ノード仕様書・運用テストガイド用テンプレートを提供します。フロー要件定義テンプレート(基本情報・機能要件・非機能要件・外部連携/設定・受入基準・メモ/課題)、進捗ログテンプレート、ノード仕様書テンプレート(ノード一覧・変数・設定)、運用テストガイドテンプレート(運用手順・テストケース・トラブルシューティング)を標準化し、フロー開発の品質と一貫性を保証します。" --- # フロードキュメントテンプレート Workflow ## Instructions 1. Preflight: - `./questions/docs_questions.md` で作成するドキュメント種別を確認する - 対象フローのYAMLファイル・メタデータを確認する - 既存ドキュメントの有無を確認する - 依頼文に記載された参照資料を全て読み込む - 確認できなかった資料は「未参照一覧」として記録する 2. 生成: - **要件定義書テンプレート** - `./assets/flow_requirements_template.md` を使用 - 基本情報・機能要件・非機能要件・外部連携/設定・受入基準・メモ/課題を記入 - 出力先: `{{patterns.flow_requirements_doc_workflow}}` - **進捗ログテンプレート** - `./assets/flow_progress_template.md` を使用 - 日付・作業内容・ステータス・備考を記録 - 出力先: `{{patterns.flow_progress_log_doc_workflow}}` - **ノード仕様書テンプレート** - `./assets/node_specification_template.md` を使用 - ノード一覧・変数・設定を文書化 - 出力先: `{{patterns.workflow_node_specification_doc}}` - **運用テストガイドテンプレート** - `./assets/operation_test_guide_template.md` を使用 - 運用手順・テストケース・トラブルシューティングを記載 - 出力先: `{{patterns.workflow_operation_test_guide_doc}}` - テンプレートの必須項目は必ず記入すること - 日付は自動挿入される変数を使用 - プロジェクト固有情報は適切に置換 3. QC(必須): - 共通QC Subagent(`qa-skill-qc`)に評価・チェックを委譲する - Subagentは最初に `./evaluation/evaluation_criteria.md` をReadし、評価指標に基づいてQCを実施する - チェック観点: - 必須項目がすべて埋まっていること - フローとの整合性が取れていること - テンプレート形式に準拠していること - 指摘を最小差分で反映する - 指摘に対し「修正した/しない」と理由を成果物に残す 4. バックログ反映: - ドキュメント作成完了後、レビュー・承認のタスクを抽出する - 反映先・編集制約・差分提示は CLAUDE.md の全体ルールに従う subagent_policy: - 品質ループ(QC/チェック/フィードバック)は必ずサブエージェントへ委譲する - サブエージェントの指摘を反映し、反映結果(修正有無/理由)を成果物に残す - 複数ドキュメントの並列生成はSubagentで実行可能 recommended_subagents: - qa-skill-qc: 共通QC。対象Skillの ./evaluation/evaluation_criteria.md を先にReadしてからQCを開始 ## Resources - questions: ./questions/docs_questions.md - assets: - ./assets/flow_requirements_template.md - ./assets/flow_progress_template.md - ./assets/node_specification_template.md - ./assets/operation_test_guide_template.md - evaluation: ./evaluation/evaluation_criteria.md - triggers: ./triggers/next_action_triggers.md - scripts: - ./scripts/dify_validation.py - ./scripts/dify_import_api.py ## Next Action - triggers: ./triggers/next_action_triggers.md 起動条件に従い、条件を満たすSkillを自動実行する。 ## Error Handling - template_variable_error: 変数名の形式を確認({{env.NOW:date:YYYY-MM-DD}}等)、必須変数が設定されているか確認 - output_path_error: パスの存在を確認、書き込み権限を確認 - missing_required_field: テンプレートの必須項目を確認、(記入)となっている箇所をすべて記入 ## ドキュメント保存先 ``` {project_base_dir}/docs/flows/{workflow_filename}/ ├── requirements.md # 要件定義書 ├── progress.md # 進捗ログ ├── node_specification.md # ノード仕様書 └── operation_test_guide.md # 運用テストガイド ```