# Add Doc

> ソースコードの内容を読み取り、対応するドキュメント（index.md）にセクションを追記する。ユーザーが新しいサンプルコードを追加した際にドキュメントを自動生成するために使用する。 Use when this capability is needed.

- Skill: `tomevault-io/add-doc-2` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/add-doc-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/add-doc-2/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/add-doc-2

---


# ドキュメント追記スキル

ソースコードファイルのパスを受け取り、対応する章のドキュメント（`index.md`）に新しいセクションを追記する。

## 手順

1. **ソースコードを読む**: `$ARGUMENTS` のファイルを読み込み、内容を把握する
2. **対応するドキュメントを特定する**: ソースコードのパス（例: `packages/@ai-suburi/core/chapter3/...`）から章番号を特定し、`packages/@ai-suburi/docs/docs/chapter<N>/index.md` を読む
3. **既存のドキュメントスタイルを分析する**: 既存セクションの構成（見出し・説明・コードブロック・実行方法）を把握する
4. **以下の構成で新しいセクションを追記する**:

### 追記するセクションの構成

```
## <セクション番号>. <セクションタイトル>

<概要説明（2〜3文）>

### <サブ見出し（必要に応じて）>

<詳細説明やテーブル>

### <サンプルの説明見出し>

このサンプルでは以下を行います。

- ポイント1
- ポイント2
- ...

\```typescript title="chapter<N>/<ファイル名>.ts"
<ソースコード全文>
\```

**実行方法:**

\```bash
pnpm tsx chapter<N>/<ファイル名>.ts
\```
```

## 新規ページ（mdファイル）を作成する場合

新しい章やセクションとして md ファイルを新規作成した場合は、フッターにもリンクを追加する。

1. `packages/@ai-suburi/docs/docusaurus.config.ts` を開く
2. `footer.links` 配列の中から、対応するカテゴリの `items` を探す
3. 既存のリンク一覧の末尾に、新しいページへのリンクを追加する

```typescript
{
  label: '<Chapter N: ページタイトル>',
  to: '/docs/<カテゴリ>/<ファイル名（拡張子なし）>',
},
```

例: `docs/ai-agent-practice/chapter4.md` を追加した場合、「AI エージェント実践入門」カテゴリの `items` 末尾に以下を追加する。

```typescript
{
  label: 'Chapter 4: ヘルプデスク担当者を支援するAIエージェントの実装',
  to: '/docs/ai-agent-practice/chapter4',
},
```

## 追記時のルール

- ファイル名からセクション番号を抽出する（例: `test3-8-xxx.ts` → セクション `3-8`）
- 既存のセクション見出しと重複しないようにする（MD024 lint ルール対策）
- 概要テーブル（`| セクション | 内容 |`）にも新しいセクションの行を追加する
- 「この章で学ぶこと」の箇条書きにも新しい項目を追加する
- 参考文献セクションに関連するリンクがあれば追加する
- `---` 区切り線の前（参考文献セクションの直前）に新しいセクションを挿入する
- ソースコードのファイル名に説明文がない場合（例: `test3-11.ts`）、既存の命名規則（`test<章>-<番号>-<説明>.ts`）に合わせてリネームする（例: `test3-11.ts` → `test3-11-text-to-sql.ts`）。リネーム後はドキュメント内の参照（コードブロックの `title` や実行方法の `pnpm tsx` コマンド）もすべて更新する

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/imamachi-n) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-13 -->