Skip to content

feat: add documenter role workflow - #110

Merged
version-1 merged 2 commits into
mainfrom
docs/refine-documenting-workflow
Jul 30, 2026
Merged

feat: add documenter role workflow#110
version-1 merged 2 commits into
mainfrom
docs/refine-documenting-workflow

Conversation

@version-1

Copy link
Copy Markdown
Owner

Documenter role と文書化ワークフローの追加

Summary

技術文書の作成・更新を、調査から構成、作成、文書全体のレビュー、再構築まで一貫して進められるようにします。

既存の documenter agent を、他の role と同じ「委譲入口 → agent 定義 → playbook」の構成へ接続します。

主な変更点:

  • documenting skill に必須の5段階ワークフローを追加
  • role-documenterrole-documenter-playbook を追加
  • Codex / Claude の既存 documenter agent を新しい playbook へ接続
  • skill の一覧、依存マップ、positive / negative eval を追加

やったこと

  • ドキュメント全体の冗長さ、重複、整合性、分割の必要性を確認するレビュー手順を明文化
  • レビュー結果に応じて構成から再検討し、全体を再構築する方針を追加
  • Documenter、Scouter、Planner、Implementer、Reviewer の責務境界を定義
  • role-doc を参照していた Codex / Claude agent 定義を修正

動作確認

  • skill の YAML frontmatter を検証
  • evals.json の JSON 構文を検証
  • git diff --check
  • GOMODCACHE=/tmp/gomodcache GOCACHE=/tmp/gocache GOTOOLCHAIN=local make deploy-dry-run

レビュー & 動作確認 チェックリスト

  • 委譲の入口 - 文書作成・更新依頼で role-documenter が適切に選択されること
  • Agent の接続 - Codex / Claude の documenterrole-documenter-playbook を参照すること
  • 文書全体のレビュー - 冗長さ、重複、整合性、Progressive Disclosure の確認が必須になっていること

推奨テスト計画:

  1. role-documenter/evals/evals.json の positive / negative ケースを実モデルで評価する
  2. role-documenter-playbook/evals/evals.json の文書作成・再構築ケースを実モデルで評価する
  3. deploy dry-run で Codex / Claude の skill と agent が配布対象になることを確認する

その他気になることや相談ごと

リポジトリ内に skill routing eval の実行 runner がないため、追加した eval の実モデル検証は未実施です。PR 前レビューでは Medium として指摘され、High 指摘はありませんでした。

Document the required research, outlining, drafting, whole-document review, and reconstruction steps for documentation work.\n\nValidation: checked YAML frontmatter and git diff --check.
Add the role-documenter delegation entry and role-documenter-playbook workflow, connect existing Codex and Claude documenter agents, and document the new skills and dependency.\n\nValidation: JSON and YAML validation, git diff --check, and make deploy-dry-run with temporary Go caches.
@version-1
version-1 merged commit 86c6a63 into main Jul 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant