tech-storyteller

Files (4)

• SKILL.md
• api.md · references/
• guide.md · references/
• .gitkeep · scripts/

SKILL.md (first lines)

# Tech Storyteller Skill

このスキルは、コードやログの断片を、ブログ記事やドキュメントの「素材」へと変換するための手順と知識を提供します。開発プロセスを客観的に観察し、背後にあるストーリーを掘り起こします。

## 使用タイミング (When to Use)

- 開発作業の区切りで、何をしたかを振り返り、アウトプットのネタを探したいとき。
- 複雑な修正の意図を Git 履歴やチャットログから再構成したいとき。
- 技術レポート、週報、PR 説明文などのための「事実に基づいた正確な素材集」を作成したいとき。

## 核となる機能 (Core Features)

### 1. リポジトリ考古学
- **情報の収集**: プロジェクト内のソースコード、コミットログ、および既存のドキュメント（機能仕様書、設計書など）を読み込み、変更の文脈を理解します。
- **ストーリーの構築**: 単なる事実の羅列ではなく、「なぜその変更が必要だったか」「どのような課題を解決したか」という物語（コンテキスト）を構築します。
- **ドキュメント連携**: アーキテクチャ図や変更履歴を参照し、プロジェクトの全体像と個別の変更を紐付けます。

## ワークフロー

### 1. コンテキストの収集
- `git log` で直近の変更を確認。
- 関連するソースコードと、もしあれば機能仕様書や設計書を読み込む。
    - **探索**: ドキュメントの場所が不明な場合、開発ドキュメントディレクトリや `README.md` を起点に探索を行う。

### 2. ストーリーのプロット作成
- 以下の要素を含むプロットを作成：
    - **背景**: 課題と動機
    - **アプローチ**: 解決策の選択理由
    - **結果**: 実装の成果と影響

### 3. 素材の提供
- `blog-writer` や `tech-writer` が記事を書くための「ネタ帳（Context Note）」を作成し、引き渡す。
- **背景**: なぜこの機能/修正が必要だったか。
- **技術的詳細**: どのような技術スタックを使い、どのような実装をしたか。
1.  **環境探索**: `git log` やプロジェクトディレクトリを走査し、関連性の高いファイルや履歴を特定。
2.  **事実の整理**: 時系列またはテーマ別（機能追加、バグ修正、設計変更）に出来事を整理。
3.  **ストーリー化**: 単なる履歴の羅列ではなく、「課題 → 試行錯誤 → 解決」という物語の骨子を抽出。
4.  **素材の出力**: Markdown 形式で、ブログ、ドキュメント、または人間が読むための素材集を出力。

From Keiji-Miyake/kanon-ag, MIT.

More from Keiji-Miyake/kanon-ag