agentleFS
ryusuke-airyusuke-ai/argus/.claude/skills/doc-generate/SKILL.md

doc-generate

Skill1 starsChanged 9 months agoMITView on GitHub

学習科学に基づく技術ドキュメントを生成。「ドキュメント作成」「ドキュメント生成」「docs書いて」「技術文書」「解説ドキュメント」で発動。

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

Documentation Generator

学習科学の原則に基づき、読者が確実に理解できる技術ドキュメントを生成するスキル。

発動条件

  • 「ドキュメント作成」「ドキュメント生成」「docs書いて」
  • 「技術文書を書いて」「解説ドキュメント」
  • 新しい技術ドキュメントの作成を依頼された時

ドキュメント種別の判定

ユーザーの要求種別テンプレート
「なぜこの技術を選んだか」「技術選定」技術選定ドキュメント@references/section-templates.md の「技術選定」セクション
「コードの解説」「構成を説明」コードベース解説ドキュメント@references/section-templates.md の「コードベース解説」セクション
「使い方」「セットアップ」ハウツーガイド@references/section-templates.md の「ハウツーガイド」セクション

ワークフロー

[Phase 1] 調査・設計
├── 対象の理解(コード読解 / 技術調査)
├── 読者レベルの確認
└── セクション構成の設計

[Phase 2] 執筆
├── セクション構成テンプレートに従い執筆
├── 学習科学の原則を適用
└── コード例・比較表・図の作成

[Phase 3] 整合性チェック
├── 理解度チェックの整合性検証(最重要)
├── フォーマット規則の確認
└── 読み直しと推敲

学習科学の原則(必ず適用)

詳細は @references/learning-science.md を参照

原則適用方法必須度
Feynman Technique1セクション = 1概念。6歳に説明するつもりで書く必須
アクティブリコール各セクション末尾に「理解度チェック」を配置必須
スキャフォールディング概要 → 詳細 → コードの順で段階的に深掘り必須
チャンキング1セクション内の情報は 3〜5 個の塊に整理必須
具体例 → 抽象化まずコード例を見せ、そこからパターンを抽出推奨
スパイラル学習同じ概念にセクションを跨いで異なる深さで再登場推奨

セクション構成テンプレート

詳細は @references/section-templates.md を参照

フォーマット規則

詳細は @references/formatting-rules.md を参照

理解度チェックの鉄則(最重要ルール)

理解度チェックの全ての問題は、そのセクション内(チェックより前の部分)の記述だけで答えが導けなければならない。

チェックリスト:

  1. 問題を作成したら、セクション内に答えの根拠があるか逆引き確認する
  2. 「〜の理由を説明できるか?」→ 本文に「なぜ」の説明があるか
  3. 「〜を N つ挙げられるか?」→ 本文に N 個以上の項目が列挙されているか
  4. 「〜が適しているケースは?」→ 本文にそのケースの説明があるか
  5. 本文を変更したら、既存の理解度チェックに影響がないか確認する

既存ドキュメントの参照

Argus プロジェクトの実例:

  • 技術選定: docs/TECH_STACK_AND_ARCHITECTURE.md
  • コードベース解説: docs/PROJECT_STRUCTURE_AND_CODEBASE_GUIDE.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.