review-docs
Review documentation for broken links and cross-document consistency issues. Trigger when the user says: "ドキュメントレビュー", "docs review", "review docs", "リンク切れ確認", "ドキュメントの整合性", or similar phrases requesting documentation review.
原文 · 暂不支持此原文语言适用对象:办公与团队协作。自动收录 · 待核查。
原作者说明节选
从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。
查看日文原文
原文涵盖的主题
- Review Docs Skill
- アーキテクチャ
- 手順
- 1. サブエージェントを並列起動する
- サブエージェント A — リンク切れチェック
- サブエージェント B — 整合性チェック
- 2. 両エージェントの結果を受け取る
- 3. レポートの生成
docs/ 以下のドキュメント全体を走査し、リンク切れと整合性問題を検出してレポートを出力する。 このスキルは処理を2つのサブエージェントに分担させることでメインのコンテキストを節約する。 以下の2つの Explore エージェントを 同時に(1メッセージで) 起動する。 -- プロンプト(要旨): docs//.md および CLAUDE.md 全件を読み込み、各ファイルに含まれる Markdown リンク text と画像参照 alt を抽出せよ。 チェック対象: - 相対パス参照 → リポジトリルートから解決して実ファイルの存在確認 - アンカー付きリンク text → 対象ファイルに該当見出し(# ..., ## ... 等)が存在するか確認 - / 始まりの絶対パス → リポジトリルートから存在確認 チェック対象外: - http://, https:// で始まる外部リンク 結果は以下の形式で返せ: BROKENLINK|ファイルパス|行番号|リンク記述|理由 BROKENLINK|docs/requirements.md|125|コアコンセプト|ファイルが存在しない OKLINKCOUNT|32 TOTALFILES|18 -- プロンプト(要旨): docs/ 以下のすべての Markdown ファイルを読み込み、以下の観点で整合性を確認せよ。 各観点は対応するディレクトリ・ドキュメントが存在する場合のみ実行し、無ければスキップする。 1. CLAUDE.md ドキュメント表 CLAUDE.md 内に「ドキュメント」表(または同等のパス一覧)が存在する場合、記載されたファイルパスが実在するか確認する。 2. ADR ↔ Design Doc の対応(docs/adr/ がある場合のみ) - ADR に「関連」として記載された Design Doc のパスが実在するか - Design Doc のステータスが「ADR化」の場合、対応する ADR ファイルが存在するか 3. Design Doc のステータスと実装状態の乖離(docs/design/ がある場合のみ) - ステータスが「完了」の Design Doc に対応する ADR が存在しないもの(警告) - ステータスが「ドラフト」「検討中」のまま実装されていそうなもの(git history は見なくてよい、判断できる範囲で) 4. Design Doc ↔ AT の対応(docs/design/ と docs/acceptance/ の両方がある場合のみ) - 各 Design Doc に対応する AT(docs/acceptance/)が存在するか(なければ警告のみ) 5. AT 番号の重複(docs/acceptance/ がある場合のみ) - docs/acceptance/
这里只展示节选,请以完整原文和当前要求为准。
- 来源仓库
- kompiro/hane
- 源文件
- skills/review-docs/SKILL.md
- 固定版本
- e43182fb7d2abb7ea0ffb21f030479966cd2ee05
来源与内容状态
本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。
原作者:kompiro/hane · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-10T09:01:55.373Z。
分类由名称、说明与路径规则生成,分类不代表已核实适配。
许可与权利归属
MIT。第三方内容及版权归原作者,使用条件以原文为准。
许可原文 ↗本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。
限制与注意事项
- 元数据收录不代表本站已经安装、适配、实测或进行安全审查。