miko.setup

Files (1)

• SKILL.md

SKILL.md (first lines)

## 入力

```text
$ARGUMENTS
```

入力は任意のプロジェクト概要（省略可）。

- 例: `/miko.setup ECサイトのバックエンド API`
- 例: `/miko.setup`

---

## このスキルの役割

miko を新しいプロジェクトに導入するための初期セットアップ。プロジェクトのコードベースを調査し、`miko/system_high_level_design.md` を生成する。

このファイルは miko の全スキル（catchup、new-cap、propose 等）がコード探索・精読の際に参照する **コード探索ガイド** を含む。プロジェクト固有のフレームワーク・ディレクトリ構成・命名規約・ビジネスルール抽出パターンを記述することで、スキル側にフレームワーク依存の知識を持たせずに済む。

**出力:** `miko/system_high_level_design.md`

---

## 手順

### 1. 既存ファイル確認

- `miko/system_high_level_design.md` が既に存在するか確認する
- **存在する場合はエラーとして中止する:**
  > ⛩️  `miko/system_high_level_design.md` が既に存在しております。
  > 内容の更新は直接編集するか、削除してから再実行をお願いいたします。

### 2. ガイドと参考資料の読み込み

以下のファイルを読み込む。

**指示書（必須）:**
- `.miko/guides/tone_guide.md` — ユーザーとの対話スタイル。**このファイルの口調・絵文字・出力言語ルールに従うこと**

**実例（品質の基準）:**
- `.miko/examples/system_high_level_design.md` — システム HLD のサンプル。**このファイルと同等の構造・詳細度を目指す**

### 3. プロジェクト調査（サブエージェント並列）

プロジェクトのコードベースを自動的に調査する。**ユーザーに質問する前に** 可能な限り情報を集める。

**探索対象外:** `.miko/` ディレクトリは miko の内部リソースであり、プロジェクトのコードではない。探索・精読の対象にしないこと。

**以下の 3 つのサブエージェント（Agent ツール、`subagent_type: "Explore"`、`model: "sonnet"`）を並列に起動する。** 各エージェントには調査項目を指示し、結果をテキストで返させる。

#### サブエージェント A: 基盤構成の調査

1. **フレームワーク・言語の特定**
   - パッケージ管理ファイル（`Gemfile`, `package.json`, `go.mod`, `pyproject.toml`, `Cargo.toml` 等）を探す
   - フレームワーク固有の設定ファイル（`config/routes.rb`, `next.config.js`, `settings.py` 等）を探す
   - 言語バージョンファイル（`.ruby-version`, `.node-version`, `.tool-versions` 等）を探す

2. **ディレクトリ構成の把握**
   - トップレベルのディレクトリ構造を確認する
   - 主要なソースコードのディレクトリを特定する
   - テスト・設定・インフラのディレクトリを特定する

3. **レイヤー構成の推定**
   - フレームワークの規約に基づくレイヤー分けを特定する
   - 各レイヤーの責務とディレクトリの対応を整理する

#### サブエージェント B: 設計構造の調査

4. **命名規約の把握**
   - ファイル名とクラス/モジュール名の対応パターンを確認する（数ファイルをサンプリング）

5. **API 構造の把握**
   - ルーティング定義やエンドポイント一覧を確認する
   - 認証方式を確認する

6. **テナント構造の推定**
   - マルチテナントかシングルテナントかを判定する
   - テナントの単位（組織、ユーザー等）を特定する

#### サブエージェント C: ルール抽出パターンの調査

7. **ビジネスルール抽出パターンの特定**
   - このプロジェクトでバリデーションがどう書かれているか（数ファイルをサンプリング）
   - 状態定義・enum の書き方
   - 認可・アクセス制御の仕組み
   - ライフサイクルフックの書き方
   - 外部通信の書き方

**全サブエージェントの完了後、** 結果を統合して次のステップに進む。

### 4. 【確認①】調査結果の確認

調査結果を「フレームワーク・言語」「ディレクトリ構成」「レイヤー構成」「API構造」「テナント構造」「ビジネスルール抽出の着目点」「ケイパビリティ候補」にまとめてユーザーに提示する。特にテナント構造、レイヤー構成の抜け、着目点のコード例の代表性を確認する。フィードバックを反映して再提示、承認されたら次に進む。

### 5. ファイル生成

確認①のフィードバックを反映し、`miko/system_high_level_design.md` を生成する。

**構造:** `.miko/examples/system_high_level_design.md` に準拠する。

**必須セクション:**
- **システム概要** — プロジェクトの概要。1〜2文
- **テナント構造** — テナントの単位とデータの隔離方式（シングルテナントの場合はその旨）
- **API 構造** — エンドポイントのパターンと認証方式
- **ケイパビリティ一覧** — 既存のケイパビリティ候補（空テーブルでもよい。今後 new-cap で追加される）
- **コード探索ガイド**
  - フレームワーク・言語
  - ディレクトリ構成
  - レイヤー構成と責務
  - ファイル命名規約
  - ビジネスルール抽出の着目点

**生成時の注意:**
- コード探索ガイドはこのプロジェクトで miko を使う全スキルの基盤。正確さと網羅性を重視する
- 着目点の「例」列には、実際のプロジェクトのコードから取ったサンプルを記載する
- ケイパビリティ一覧は暫定。ユーザーが今後 `/miko.new-cap` で正式に定義していく

**`miko/glossary.md` の生成:**

From studyplus/miko, MIT.

More from studyplus/miko