Back to skills
extension
Category: Development & EngineeringNo API key required

glossary-creation

Create and update the project glossary (docs/glossary.md). This task is triggered upon requests such as 'create a glossary', 'organize terms', 'unify term definitions', 'update the glossary', 'define the terms for this project', 'compile technical terms', etc. Extract terms from the documentation, then organize and output their definitions, related terms, usage examples, and implementation locations.

personAuthor: jakexiaohubgithub

Glossary Creation Skill

プロジェクト内の用語を定義・統一し、認識の齟齬を防ぐ。

入出力

| 種別 | パス | |------|------| | 入力 | docs/product-requirements.md | | 入力 | docs/functional-design.md | | 入力 | docs/architecture.md | | 入力 | docs/repository-structure.md | | 入力 | docs/glossary.md(既存あれば優先) | | 出力 | docs/glossary.md |

参照ファイル

| ファイル | 読むタイミング | |----------|----------------| | ./template.md | 新規作成時のベース | | ./reference.md | 用語抽出基準・レビュー観点 |

手順

1. 用語抽出

docs群を読み、以下の基準で用語を抽出:
- 繰り返し登場する専門用語
- 定義が曖昧になりがちな概念
- プロジェクト固有の造語・略語
- 一般用語だが本プロジェクトで特別な意味を持つもの

2. 既存用語集の確認

  • docs/glossary.md が存在する?
    • Yes → 構造・既存定義を維持して追加・更新
    • No./template.md をコピーして新規作成

3. 用語の分類

./template.md のカテゴリに従って分類:

| カテゴリ | 内容 | 例 | |---------|------|-----| | ドメイン用語 | ビジネス・機能の概念 | 診断、稟議、推薦 | | 技術用語 | 技術・FW・ツール | Supabase、RLS、RSC | | アーキテクチャ用語 | システム設計の概念 | レイヤー、Repository | | ステータス・状態 | システム内の状態値 | draft, active, archived | | 略語・頭字語 | 略語とその展開 | PRD, KPI, DAU |

4. 各用語の定義

用語ごとに以下を埋める:

| 項目 | 内容 | 必須 | |------|------|------| | 定義 | 明確で一意な説明 | ✅ | | 説明 | 補足・背景 | 任意 | | 関連用語 | 他の用語へのリンク | ✅ | | 使用例 | 「〇〇を△△する」形式 | ✅ | | 実装箇所 | コード/テーブル名 | 技術用語時 |

5. レビュー

./reference.md のチェックリストで確認:

  • [ ] 定義が曖昧でない(誰が読んでも同じ理解)
  • [ ] 具体例がある
  • [ ] 関連用語がリンクされている
  • [ ] カテゴリ分けが適切

6. 出力

docs/glossary.md を作成/更新し、追加/変更した用語をサマリ提示

発火例

  • 「用語集を作って」
  • 「用語を整理して」
  • 「このプロジェクトの専門用語をまとめて」
  • 「PRDに出てくる用語を定義して」
  • 「glossaryを更新して」

境界(やらないこと)

  • 要件定義prd-writing スキル
  • 機能設計functional-design スキル
  • 一般的な技術用語の説明(プロジェクト固有でないもの)→ 外部ドキュメント参照