mcpField
D
doom-doc-assistant

doom-doc-assistant

github.com/alaudaドキュメント052 回インストール16 週間前に更新
リポジトリ

doom-doc-assistant について

Doom のドキュメントリポジトリでの作業を支援するスキルです。規約の確認、変更計画、製品ドキュメントの作成を対象とし、編集前にリポジトリに基づく診断と確認を求めます。製品ドキュメントは英語で作成します。

主な機能

  1. 01レビュー・文書作業・コマンド作業を分類
  2. 02リポジトリ規則と関連ページを確認
  3. 03編集前に診断と計画を提示
  4. 04優先順位に沿って規則を適用
  5. 05製品ドキュメントを英語に限定

活用シーン

  1. 01要件に基づく Doom ドキュメント更新の計画
  2. 02構成、規約、AI 利用性のレビュー
  3. 03明示された yarn build または yarn translate の個別実行

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/alauda/agent-skills --skill doom-doc-assistant

インストール後、Claude Code で/doom-doc-assistantを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

AGENTS.md
CLAUDE.md
references/
regression-cases.md
rules/
ai-usable-docs.md
best-practices.md
common-pitfalls.md
content-elements.md
core-conventions.md
language-style.md
markdown-formatting.md
mdx-components.md
metadata-rules.md
terminology-consistency.md
terminology-guide.md
verification-checklist.md
templates/
arch-template.mdx
concept-template.mdx
diagnosis-report.md
function-template.mdx
howto-template.mdx
installation-template.mdx
intro-template.mdx
quickstart-template.mdx
release-notes-template.mdx
spec-review-report.md
troubleshooting-template.mdx
upgrade-template.mdx

詳細

Doom ドキュメントアシスタント

基本的な運用ルール

  • ユーザーの承認なしにファイルを直接変更しないでください。必ず最初に診断結果または計画を提示し、確認を待ってください。
  • 明示された対象リポジトリのルールを最優先します。ただし、従来のサンプルによって、このスキルに組み込まれた製品ドキュメントの基準が上書きされないようにしてください。
  • 明示されたリポジトリのルールが、組み込みの製品ドキュメントのルールより優先される場合は、その旨を出力内で明示してください。たとえば、Repository rules override the skill defaults here: ... のような表現を使ってください。
  • アシスタント向けの出力言語と、ドキュメント内容の言語は別々に判断してください。
  • 製品ドキュメントの内容は英語で記述する必要があります。このスキルで中国語の製品ドキュメントを作成しないでください。
  • Doom/Yarn のドキュメントリポジトリでは、手動での受け入れ確認に備えるため、標準では yarn up @alauda/doom を実行してから yarn install を実行し、その後、作業を人間のレビュアーに引き渡します。
  • yarn dev を自動的に実行しないでください。人間のレビュアーは、ローカルプレビューの準備が正常に完了した後に限り、ローカルで yarn dev を実行します。
  • yarn build や yarn translate を自動的に、または標準手順として実行しないでください。ユーザーが別タスクとして明示的に要求した場合に限り、これらのコマンドの実行を検討してください。

ルールの優先順位

次の順序でガイダンスを適用してください。

  1. ユーザーのタスク範囲と、明示された対象リポジトリのルール
  2. このスキルに組み込まれた製品ドキュメントの基準
  3. 対象ディレクトリ内および隣接モジュール内の実際のドキュメント。ただし、製品ドキュメントの基準に反しない範囲で、配置、順序、スタイルを決める場合に限ります
  4. templates/*

優先順位の低い情報源によって、優先順位の高い情報源を上書きしないでください。 製品ドキュメントの内容の言語は、このスキルで上書きできないルールです。英語の内容のみを記述してください。

使用する場合

Doom または @alauda/doom のドキュメントリポジトリで、ユーザーが次のいずれかを依頼した場合に、このスキルを有効にしてください。

  • 要件、PRD、機能に関するメモをドキュメントの更新に反映する
  • 既存の正式なページを変更する
  • 既存のセクションに、シナリオに焦点を当てた新しいドキュメントを追加する
  • ドキュメントの再構成、分割、統合が必要かどうかを評価する
  • Doom のドキュメント規約、MDX コンポーネントの使用方法、用語を確認する
  • 同じドキュメントリポジトリについて yarn build または yarn translate の実行を明示的に依頼された場合に、これらのコマンドを標準の検証手順とせずに対応する

ワークフロー

次の手順に従ってください。手順を省略しないでください。

1. アシスタント向けの出力言語を決める
  1. 診断レポート、実行計画、質問、その他の出力でアシスタントが使用する言語を決めます。
  2. ユーザーがすでに希望を示している場合は、その言語を使用します。
  3. 現在の会話から希望が明らかな場合は、その言語に従います。
  4. 希望が明示されていない場合は、アシスタント向けの出力を英語と中国語のどちらにするか、ユーザーに尋ねます。
  5. この選択はアシスタントが表示する出力にのみ適用され、このスキルで作成するドキュメントの内容は引き続き英語のみであることを明確にします。

成功基準:リポジトリの分析を始める前に、ドキュメントの内容を英語のみとしたまま、レポートや質問を英語と中国語のどちらで表示するかが決まっていること。

2. リポジトリを確認する
  1. 対象のリポジトリを特定します。
    • 現在のワークスペースがすでにドキュメントリポジトリのようであれば、それを使用します。
    • 実際の .mdx ページがある docs ツリー、Doom の設定ファイル、既存の Doom MDX コンポーネントの使用など、ドキュメントリポジトリであることを明確に示す要素がある場合に限り、現在のワークスペースを対象のリポジトリとして扱います。
    • 汎用的な AGENTS.md ファイルだけでは、現在のワークスペースが対象のドキュメントリポジトリである十分な根拠にはなりません。
    • 現在のワークスペースが対象のリポジトリであると明確に判断できず、ユーザーがパスを指定している場合は、そのパスを使用します。
    • リポジトリの場所が明確でない場合に限り、パスを尋ねます。
  2. 対象のリポジトリに AGENTS.md がある場合は、組み込みルールを適用する前に読みます。
  3. rg、ls、ファイルの読み取りを使って、関連するディレクトリを調べます。
  4. キーワードの見落としを避けるため、要件に含まれる複数のキーワードで検索します。
  5. 配置場所、weight の値、任意のメタデータ、カテゴリの値を提案する前に、同じディレクトリまたは隣接するモジュールにあるページを 3~5 件確認します。
  6. MDX コンポーネントを推奨する前に、リポジトリ内で実際の使用例を検索します。
  7. ユーザーが中国語の製品ドキュメントの作成を依頼した場合、または docs/zh への書き込みを求めた場合は、作業を中止し、このスキルでは英語の製品ドキュメントのみを作成すると説明します。英語の対象パスまたは英語のコンテンツを指定するよう依頼します。
  8. 標準的なローカルプレビューの準備が適用されると想定する前に、ルートの package.json、Yarn の使用状況、dev スクリプト、doom dev、@alauda/doom など、Doom/Yarn リポジトリの兆候があるか確認します。

成功の基準:対象リポジトリのルート、正本となる可能性が高いページまたはセクション、見つかったローカルの慣例、および標準的な Doom/Yarn のプレビュー準備が適用されるかどうかを特定できていること。

3. リクエストを分類する

編集を計画する前に、リクエストを分類します。

  • review/audit only:ユーザーがドキュメントの規約を調査、レビュー、監査、リント、確認することのみを求めており、変更は求めていません。
  • documentation collaboration:ユーザーがドキュメントの作成、変更、再構成、草案作成を求めています。
  • explicit command task:ユーザーが yarn build または yarn translate の実行を明示的に求めています。

リクエストが review/audit only の場合:

  1. ワークフローを読み取り専用にします。
  2. 依頼された確認に必要なルールのみを読み込みます。ドキュメントがAIにとって利用しやすいか、自己完結しているか、アシスタントにとって十分に網羅されているか、自動レビューや検索に対応できる状態かをユーザーが尋ねている場合は、rules/ai-usable-docs.md も含めます。
  3. リポジトリの例と対象ドキュメントを調査します。
  4. Output Contracts の規定に従い、Review Findings Report を出力します。該当する場合は、書式や Doom の規約だけでなく、AI にとっての使いやすさの観点も適用します。
  5. 実行計画を出力したり、ファイルを変更したり、yarn up @alauda/doom や yarn install を実行したり、yarn dev に引き継いだりしないでください。
  6. 検出事項の修正計画が必要かどうか、ユーザーに確認します。
  7. ユーザーが編集を依頼しない限り、そこで終了します。

リクエストに explicit command task が含まれる場合:

  1. yarn build または yarn translate は、別途明示的に依頼されたタスクとして扱います。
  2. どちらのコマンドも、ドキュメント共同作業におけるデフォルトの検証フローに追加しないでください。
  3. ローカルプレビューの準備に失敗した場合や、準備が不要な場合に、どちらかのコマンドで代用しないでください。
  4. ドキュメントの変更も依頼されている場合は、通常のドキュメント共同作業の計画と、明示的なコマンドタスクを分けてください。
  5. 明示的なコマンドを実行する前に、コマンド、対象範囲、想定される出力または失敗時の対応を正確に伝えます。
  6. コマンドの実行のみが依頼されている場合は、フェーズ 0〜9 を省略し、ステップ 10 を実行して、Explicit Command Result を出力したら終了します。
  7. ドキュメント共同作業も依頼されている場合は、フェーズ 0〜9 を完了した後、別個の明示的なコマンド分岐としてステップ 10 を実行します。

リクエストが documentation collaboration のみの場合は、フェーズ 0 に進みます。

成功条件:レビューのみの作業は検出事項の報告のみで終了し、コマンドのみの作業はドキュメント作成フェーズを省略し、明示的なコマンドを含む複合タスクはデフォルトの検証と分離され、ドキュメント共同作業は依頼された場合に段階的なワークフローを継続します。

4. フェーズ 0:受付と診断
  1. リポジトリの文脈に沿って要件を言い換えます。
  2. 最も関連性の高い既存ドキュメントを特定します。
  3. 編集を計画する前に、対象となるドキュメントのレイヤーを分類します。
    • user-facing product doc
    • engineering fact doc
    • versioned validation report
    • known issue tracker
    • evidence index
    • 対象レイヤーが user-facing product doc の場合は、ソース資料(Jira の説明、内部テストレポート、設計ドキュメント、PR の本文、チャットの記録)も確認し、内部管理用トークンを探します。対象となるのは、課題トラッカー ID(AIT-、DBS-、DEVOPS-、MIDDLEWARE-、TC-、KI-、RUS-)、内部テスト日付(Verified YYYY-MM-DD、Validated YYYY-MM-DD、on hcslab、release test)、内部判断の根拠(Path A / B / C、"Why we did not pick X")、内部リポジトリ/ビルド/成果物への参照(gitlab-ce、build-harbor、package-minio、MR !N、BuildRun <name>)です。検出した各トークンについて、顧客向けの置き換え表現、または「削除」を示す簡潔な翻訳リストを作成します。これが user-facing product doc の入力要件です。パターンの全一覧と悪い例/良い例については、rules/common-pitfalls.md Pitfall 9a を参照してください。
  4. プロバイダーのエンジニアリングドキュメント、バージョン管理されたレポート、課題トラッカー、エビデンスインデックスなど、対象ページの作成に役立つ、より信頼性の高い情報源があるかどうかも含め、ソース資料の網羅性を評価します。
  5. 次のいずれかの方針を選択します。
    • Path A:現在の構成は十分に整っているため、信頼できるページを直接修正するか、既存の構成内に目的を絞った新しいドキュメントを追加します。
    • Path B:現在の構成に大きな問題があるため、新規または改訂する内容を正しくするには、先に構成を再編する必要があります。
    • Path C:構成上の問題はありますが、今回のタスクの解決には必須ではありません。負債として記録し、最も範囲を絞った安全な作業を続けます。
  6. 変更によって前提条件、フィールドの制約、ライフサイクルの境界、または既知の制限が追加または改訂される場合は、波及リスクを特定します。そのうえで、関連するワークフローや概要ページも更新する必要があるかを判断します。
  7. templates/diagnosis-report.md を読み込み、必須項目をすべて含む診断結果を出力します。
  8. 3 つすべての方針について説明します。推奨する方針だけを出力してはいけません。
  9. 推奨する方針以外にも妥当な選択肢がある場合は、今回それらを選ばない理由を説明します。
  10. 次に進む前に、確認を求めます。

成功基準:ユーザーが要件、関連ドキュメント、ドキュメントのレイヤー、網羅性、波及リスク、Path A/B/C の定義、推奨する方針、および他の方針を選ばなかった理由を確認できます。

5. フェーズ 1:計画
  1. rules/core-conventions.md を読み込みます。
  2. rules/ai-usable-docs.md を読み込みます。
  3. ディレクトリの整合性を確認します。特に、作成または編集するディレクトリの index.mdx ルールを確認してください。
  4. タスクを次のいずれかに分類します。
    • 既存の権威あるドキュメントを変更
    • 新しいシナリオドキュメントを追加
    • ドキュメントツリーを再構成
  5. フェーズ 0 で分類したドキュメントレイヤーを引き継ぎます。ユーザーが両方を明示的に依頼しない限り、公開向け製品ドキュメントのタスクとエンジニアリング上の正確性を示す成果物を混在させないでください。
  6. リポジトリが標準の Doom/Yarn ローカルプレビュー準備に対応しているか判断します。
    • ルートの package.json、Yarn の使用、dev スクリプト、doom dev、または @alauda/doom など、リポジトリの手がかりを確認します。
    • 標準のプレビューフローが適用される場合は、yarn up @alauda/doom の後に yarn install を実行する計画を立てます。
    • これらのコマンドによって依存関係ファイルが変更される可能性がある場合は、package.json、yarn.lock、または同等の依存関係ファイルを 変更対象ファイル に含めます。
    • 標準のプレビューフローが適用されない場合は、代替の検証コマンドをでっち上げず、その旨を明記します。
  7. 明示的なリポジトリルールと、組み込みの製品ドキュメントの最低要件からメタデータ要件をまとめます。
    • 隣接ページを参照して、ローカルの weight の間隔や任意フィールドを判断します。ただし、明示的なリポジトリルールまたは組み込みの製品ドキュメント基準と矛盾しない場合に限ります。
    • テンプレートファイル名から category の値を推測してはいけません。
    • 新しい英語の製品ドキュメントでは、weight と英語の queries を必須とします。
    • AI で活用しやすい製品ドキュメントでは、検索性を大きく高める場合、queries にユーザーの意図と重要なプラットフォーム用語、フィールド名、別名を含めます。
    • 明示的なリポジトリルールで必須とされない限り、author や category は必須にしません。
    • queries のない既存ページを変更する場合は、編集範囲に応じて、フォローアップ項目または完了予定項目として記載します。
  8. ユーザー向け製品ドキュメントについて、AI で活用しやすくするために、前提となる入力、フィールド値の参照元、許可または禁止される組み合わせ、コントローラーが管理するフィールド、ワークフローの境界、トラブルシューティングの引き継ぎを明示する必要があるか判断します。
  9. 前提条件、フィールドの制約、ライフサイクルの境界、または既知の制限を追加または変更する場合は、影響を受けるすべての関連ページを 変更対象ファイル に含めるか、明示的なフォローアップ課題として記録します。ワークフローをまたぐ制約を、暗黙のうちに一つのページだけに限定しないでください。
  10. 以下のテンプレートで指定されたセクションを正確に使用して、実行計画を出力します。
  11. セクションが空の場合は None を使用します。必須セクションを省略しないでください。
  12. 次のように質問します。この計画に基づいてドキュメントの生成または変更を進めてもよろしいですか?
  13. ユーザーが確認するまで停止します。

実行計画には次の要件を使用します。

## Execution Plan

**Action Type**: [modify existing authoritative doc / add new scenario doc / restructure doc tree]
**Documentation Layer**: [user-facing product doc / engineering fact doc / versioned validation report / known issue tracker / evidence index]

### Files to Create
| File | Weight | Queries | Purpose |
|------|--------|---------|---------|
| [new lowercase_underscore path or `None`] | [weight] | [2-4 English queries] | [purpose] |

### Files to Modify
| File | Changes | Metadata Handling |
|------|---------|-------------------|
| [existing file, dependency file, or `None`] | [changes] | [preserve / add queries / follow-up / dependency update] |

### Directory Integrity Check Result
[List missing or verified `index.mdx` coverage]

### Local Preview Prep
**Applicability**: [Standard Doom/Yarn prep applies / Not applicable]
**AI Commands Before Manual Acceptance**:
- `yarn up @alauda/doom` / `None`
- `yarn install` / `None`
**Files That May Change**: [package.json / yarn.lock / equivalent files / `None`]
**Human Manual Acceptance**:
- If Local Preview Prep is `Completed`, human reviewer runs `yarn dev` locally.
- If Local Preview Prep is `Failed` or `Not applicable`, manual preview is blocked or unavailable; do not tell the human to run `yarn dev`.
**Default Prohibited Commands**:
- `yarn build`
- `yarn translate`

### Outline per Target Document
[One outline per document that will be created or materially reworked]

### Assumptions
[List assumptions or `None`]

### Acceptance Criteria
[Flat checklist or bullets]

成功基準:計画を読めば、何を作成し、何を変更するのか、どのドキュメントレイヤーに属するのか、ページをまたいだ反映が必要か、手動プレビューへの引き継ぎが可能か、そして成功をどのように判断するのかが明確であること。

6. フェーズ 2:実行
  1. ユーザーが Path B を選択した場合、再構成する前に、影響を受ける既存ドキュメントの仕様をレビューします。
  2. 起草する前に、次のルールを読み込みます。
    • rules/ai-usable-docs.md
    • rules/metadata-rules.md
    • rules/language-style.md
    • rules/content-elements.md
    • rules/markdown-formatting.md
    • rules/core-conventions.md
    • rules/common-pitfalls.md
  3. 次のルールは、必要な場合にのみ読み込みます。
    • rules/mdx-components.md
    • rules/terminology-guide.md
    • rules/terminology-consistency.md
    • rules/best-practices.md
  4. 明示されたリポジトリのルールを最優先します。過去のリポジトリのサンプルは、組み込みの製品ドキュメント標準に違反しない場合に限り、参考資料として扱います。
  5. 実際のリポジトリのページを確認してから、テンプレートを構成上の参考としてのみ使用します。過去のサンプルを根拠に、新しいハイフン付きパス、必須の queries の欠落、必須の index.mdx の欠落、または中国語の製品ドキュメント内容を追加してはいけません。
  6. 使用できる構成テンプレートは次のとおりです。
    • templates/howto-template.mdx
    • templates/function-template.mdx
    • templates/concept-template.mdx
    • templates/arch-template.mdx
    • templates/quickstart-template.mdx
    • templates/installation-template.mdx
    • templates/release-notes-template.mdx
    • templates/troubleshooting-template.mdx
    • templates/upgrade-template.mdx
    • templates/intro-template.mdx
  7. テンプレートのファイル名が示すのはコンテンツの形式であり、必須の category 値ではありません。
  8. Doom MDX コンポーネントを使用する前に、対象リポジトリ内で実際の使用例を検索します。
  9. 信頼できる例が見つからない場合は、通常の Markdown を優先するか、不確実性を明記します。
  10. フロントマターには、新しい製品ドキュメントの場合、weight と英語の queries を含めます。その他のフィールドは、明示されたリポジトリのルールで確認できた場合にのみ含めます。
  11. アシスタント向けの出力が中国語であっても、ドキュメントのタイトル、見出し、本文、例はすべて英語で記述します。
  12. ドキュメント作業の一環として、yarn build または yarn translate を自動的またはデフォルトで実行してはいけません。これらのコマンドには、別途ユーザーからの明示的な依頼が必要です。
  13. rules/ai-usable-docs.md のドキュメント階層のルールを適用します。
  • user-facing product doc では、安定した運用ガイダンスを優先します。正常な実行に関わる場合は、前提となる入力、値の取得元、マッピング、コントローラーが管理するフィールド、サポート対象の範囲を明記します。
  • engineering fact doc では、提供済みの機能、既知の不足、所有権の境界、正式には承認されていないものの存在するコードパスを区別します。
  • versioned validation report では、ref、commit SHA、検証日、昇格ステータスなどの明示的なベースライン識別子に結論を紐付けます。
  • known issue tracker では、問題がすでに解決済みであるかのように記述せず、症状、影響範囲、現時点でのガイダンス、修正方針を記録します。
  • evidence index では、長大な生ログを本文に直接記載するのではなく、外部の証拠と識別子を参照します。
  1. フィールド値がユーザー、管理者によって指定されたもの、またはプロバイダーによって認識される値であり、UI の表示値ではない場合は、そのことを明記します。
  2. 変更によって前提条件、フィールド制約、ライフサイクルの境界、または制限が導入または改訂された場合、対象となる関連ワークフローページすべてを更新するか、サマリーに明示的な対応課題を記録します。

成功基準:生成または改訂されたドキュメントが承認済みの計画に従い、リポジトリの規約に沿っており、テンプレートを根拠にした架空の標準を持ち込まないこと。

7. パス B の仕様レビュー

既存のドキュメントを再構成する場合:

  1. rules/mdx-components.md を読み込みます。
  2. :::details を除くすべての ::: ディレクティブを数えます。
  3. ディレクティブの密度を、リポジトリ内の同じ領域にある隣接ページと比較します。
  4. ドラフトがローカルのパターンを大幅に上回る場合、または明確なローカルパターンがないのに通常の注記にディレクティブを使用している場合は、次の優先順位で整理します。
    • DANGER
    • WARNING
    • TIP
    • INFO
    • NOTE
  5. リポジトリ内で確認した要件に照らして、用語、リンク、言語、MDX コンポーネント、フロントマターを確認します。
  6. コンテンツが想定されるドキュメントレイヤーに適合していること、およびエンジニアリングのベースラインに関する詳細が、ユーザーにとって明確な価値がないままユーザー向け製品ドキュメントに漏れ込んでいないことを確認します。
  7. templates/spec-review-report.md を読み込みます。
  8. 再構成を行う前に、レビュー報告書を出力します。
  9. 確認を待ちます。

成功基準:ユーザーが、現在のディレクティブ数、確認されたローカルのディレクティブ基準、コンプライアンス上の問題、ドキュメントレイヤーへの適合性、リポジトリ固有のフロントマター要件、および提案される再構成の変更内容を、実行前に確認できること。

8. 自己検証
  1. rules/verification-checklist.md を読み込みます。
  2. チェックを順番に実行します。
  3. スタイルやコンテンツのチェックの前に、計画との整合性を確認します。
  4. 明示的なリポジトリ上書き設定や、製品ドキュメントに必須の組み込み最小フィールドを含め、メタデータが承認済みの要件に一致していることを確認します。
  5. MDX コンポーネントの使用が、リポジトリ内の実例によって裏付けられていることを確認します。
  6. 対象レイヤーが user-facing product doc の場合、変更または新規作成したファイルを、rules/common-pitfalls.md Pitfall 9a で定義されている内部管理用パターン群に照らして grep します。推奨する正規表現は (AIT-|DBS-|DEVOPS-|MIDDLEWARE-|TC-|KI-|RUS-)[0-9]+、[0-9]{4}-[0-9]{2}-[0-9]{2}、および文字列リテラルの Path A、Path B、Path C、Verified、Validated、release test、hcslab、BuildRun、gitlab-ce、build-harbor、package-minio、MR ! です。該当する箇所はすべて、ドラフトを人間のレビュアーに渡す前に、明確な根拠を示すか削除する必要があります。
  7. 不一致がある場合は、黙って処理を続行せず、停止して報告します。

成功基準:出力が承認済みの計画、ローカルのメタデータ要件、リポジトリの規約に一致していること、および顧客向けページに内部管理用トークンが含まれていないことを明確に述べられること。

9. ローカルプレビューの準備と手動受け入れ
  1. ルートに package.json があるか、Yarn を使用しているか、dev スクリプト、doom dev、または @alauda/doom があるかを確認し、標準的な Doom/Yarn プレビュー準備が適用されるかを判断します。
  2. 該当する場合は、yarn up @alauda/doom、次に yarn install、続いて yarn lint <changed-dirs> を実行し、エラーが 0 件であることを必須とします。yarn lint を使えば、アンカーの不一致、不正なフロントマター、誤った見出しスラッグなどの機械的なエラーを、CI で検出されるのを待たずに数秒でローカルに検出できます。エラーが報告された場合は、処理を停止して報告してください。yarn dev を引き継ぐよう伝えたり、ドラフトの準備ができたと宣言したりしてはいけません。
  3. いずれかのコマンドが失敗した場合は、停止してブロッキングエラーを報告します。人間に yarn dev の実行を指示してはいけません。
  4. yarn dev を自動的に実行してはいけません。手動受け入れは人間のレビュアーが行います。
  5. ユーザーが別タスクとして特定のコマンドの実行を明示的に求めた場合を除き、yarn build や yarn translate を自動またはデフォルトで実行してはいけません。
  6. 標準的なプレビュー準備が適用されない場合は、yarn build、yarn translate、その他の検証コマンドで代用せず、その旨を明確に報告します。

成功基準:標準的なプレビュー準備を完了して yarn dev を人間のレビュアーに引き継ぐか、引き継ぎがブロックされている、または利用できない理由を明確に報告すること。

10. 明示的なビルドまたは翻訳タスク

ユーザーが yarn build または yarn translate を明示的に依頼した場合にのみ、このセクションを使用してください。

  1. そのコマンドがデフォルトの検証手順ではなく、ユーザーからの明示的な依頼であることを確認します。
  2. 実行前に、正確なコマンドと対象範囲を伝えます。
  3. 依頼されたコマンドのみを実行します。
  4. Output Contracts の Explicit Command Result の規約に従って、コマンドの結果を報告します。
  5. コマンドが失敗した場合は、その旨を報告し、デフォルトでドキュメントの共同作業が完了したと主張しないでください。
  6. ローカルプレビューの準備が失敗した場合や利用できない場合は、その正確なコマンドが明示的に依頼され、それが別個の作業であることをユーザーが理解している場合を除き、yarn build または yarn translate を実行しないでください。

成功基準:明示的なビルドまたは翻訳の出力が、デフォルトの手動受け入れフローとは明確に分けられていること。

出力の規約

診断レポート

以下を必ず含めます。

  • Requirement
  • Documentation Layer
  • Related Documents Found
  • Source Material Coverage
  • Propagation Risk
  • All Branching Paths
  • Recommended Path
  • Reasoning
  • 明示的な確認依頼
  • ステップ 1 で選択された、アシスタント向けの出力言語を使用します。
  • 生成または改訂したドキュメントの内容は英語のままにします。
レビュー指摘レポート

review/audit only の依頼では、以下の構成を使用し、修正を求められていない限りレポートの後で終了します。

## Review Findings Report

**Scope**: [documents, directories, or conventions reviewed]
**Review Lens**: [Doom conventions / AI usability / both]
**Repository Evidence Used**: [target AGENTS.md, sibling pages, component examples, rules loaded]
**Read-only Result**: No files modified. No local preview prep commands run.

## Findings

| Severity | Location | Finding | Recommendation |
|----------|----------|---------|----------------|
| P1/P2/P3 | [file or section] | [issue] | [actionable recommendation] |

## Non-Issues Or Confirmed Good Patterns

[List relevant passing checks or `None`]

## Suggested Next Step

[Ask whether the user wants a fix plan or implementation.]
明示的なコマンドの結果

yarn build または yarn translate が明示的に依頼されたタスクでは、以下の構成を使用します。

## Explicit Command Result

**Requested Command**: [`yarn build` / `yarn translate ...`]
**Explicit Request Evidence**: [Brief quote or summary of the user's explicit request]
**Scope**: [Repository root, package, docs path, or glob]
**Separation From Default Flow**: This command was run only because the user explicitly requested it. It is not part of default documentation verification and does not replace human `yarn dev` acceptance.

## Command Outcome

**Status**: [Succeeded / Failed / Not run]
**Output Summary**: [Short summary of relevant command output]
**Failure Handling**: [Blocking error and next step, or `None`]
ドキュメントの概要

ドキュメントを生成または改訂した後は、以下の構成を使用します。

## Documentation Summary

**Action Type**: [modify existing authoritative doc / add new scenario doc / restructure doc tree]
**Documentation Layer**: [user-facing product doc / engineering fact doc / versioned validation report / known issue tracker / evidence index]
**Execution Path**: [A / B / C]
**Evidence Used**: [Short summary]
**Repository Overrides**: [Any skill defaults that were overridden, or `None`]

## Generated Or Revised Content

[Draft, diff summary, or content]

## Local Preview Prep

**Status**: [Completed / Failed / Not applicable]
**AI Commands Run**:
- `yarn up @alauda/doom` / `None`
- `yarn install` / `None`
**Files Changed Or Potentially Changed**: [package.json / yarn.lock / equivalent files / `None`]
**Default Prohibited Commands Not Run**:
- `yarn build`
- `yarn translate`

## Manual Acceptance Handoff

- If Local Preview Prep status is `Completed`, human reviewer must run `yarn dev` locally.
- If Local Preview Prep status is `Failed` or `Not applicable`, manual preview is blocked or unavailable; do not tell the human to run `yarn dev`.
- The assistant does not run `yarn dev` automatically.
- If preview preparation failed or was not applicable, say so explicitly here and report the blocking reason.

## Verification Results

- [x] Plan consistency check
- [x] Repository metadata contract check
- [x] Structure and link check
- [x] Language and formatting check

## Technical Debt Or Follow-ups

[Optional]

デフォルトの原則

  • アシスタント向けの出力言語が明示されていない場合は、確認します。
  • このスキルを使ったリポジトリでの共同作業では、製品ドキュメントの内容は英語のみとします。
  • ドキュメントのレイヤーを明確に分けます。ユーザー向けドキュメント、エンジニアリング上の事実、検証レポート、既知の問題、エビデンスのインデックスは、それぞれ別の成果物です。
  • リポジトリまたは要件が明確に UI 優先の手順を求めていない限り、CLI 優先の手順にします。
  • Doom/Yarn リポジトリでは、手動受け入れの前に yarn up @alauda/doom を実行してローカルプレビューを準備し、その後 yarn install を実行します。
  • ローカルプレビューの準備が正常に完了した後に限り、人間のレビュアーがローカルで yarn dev を実行します。
  • yarn build と yarn translate は、デフォルトの検証コマンドではありません。
  • 用語を創作しないでください。
  • frontmatter のフィールドを創作しないでください。
  • コンポーネント構文を創作しないでください。

コメント