知りたい用語 自動調査システム¶
GitHub Issue に用語を登録するだけで、AI が自動調査し Markdown ファイルとして保存する仕組み。
使い方¶
1. Issue を作成する¶
- タイトル:
知りたい用語: 〇〇(例:知りたい用語: マイクロサービス) - 本文: 空でOK(補足があれば書いてもよい)
- ラベル:
知りたい用語を付与
ラベルを付けた瞬間に GitHub Actions が起動します。
2. 待つ(1〜2分)¶
GitHub Actions が以下を自動実行: 1. Issue タイトルから用語名を抽出 2. Gemini API (Flash) で用語を調査 3. docs/glossary/<用語名>.md としてコミット・プッシュ 4. Issue にコメントで完了通知 5. Issue を自動クローズ
3. 結果を確認する¶
docs/glossary/ 配下に Markdown ファイルが生成されます。
手動実行¶
GitHub Actions の画面から手動実行も可能です。
- リポジトリの Actions タブを開く
- Glossary Research ワークフローを選択
- Run workflow をクリック
- 用語名を入力して実行
ローカルでの実行¶
# 環境変数を設定
export GEMINI_API_KEY="your-api-key"
# 用語を調査(ファイルに保存)
python scripts/glossary/research_term.py "マイクロサービス" -o docs/glossary/マイクロサービス.md
# 標準出力に表示のみ
python scripts/glossary/research_term.py "マイクロサービス"
セットアップ(初回のみ)¶
- Google AI Studio で API キーを取得(課金なしプロジェクトで無料)
- GitHub リポジトリの Settings → Secrets and variables → Actions
- New repository secret で
GEMINI_API_KEYを追加
生成される Markdown のフォーマット¶
# 用語名
## 概要
## 注目される背景
## 核心的な考え方
## 仕組み・詳細
## 関連手法・技術との比較
## メリット
## 課題・注意点
## 代表的なツール / 実装例
## 参考URL
※ 該当しないセクションは省略されます。
コスト¶
- Gemini 2.5 Flash を使用(無料枠)
- 課金なしプロジェクトなら 完全無料(1日250リクエストまで)