Menu
実装完了後にすべてのドキュメント（README・設計書・実装計画書・API比較表・チュートリアル）を最新化する。新機能の追加、バグ修正、リファクタリング後に使用する。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | update-docs |
| description | 実装完了後にすべてのドキュメント（README・設計書・実装計画書・API比較表・チュートリアル）を最新化する。新機能の追加、バグ修正、リファクタリング後に使用する。 |
機能の実装が完了した後、関連するすべてのドキュメントを最新の状態に更新する。
以下の3つのドキュメントカテゴリを順番に更新する:
git diff HEAD~5 --name-only
git log --oneline -10
変更されたソースファイルから、どの機能が実装・変更されたかを特定する。
docs/design/<feature>.md) - API設計、型定義、Streamlit比較docs/impl/<feature>.md) - イテレーション計画、ファイル構成docs/streamlit-api-comparison.md) - 実装状況の✅/❌を更新docs/tech-blog-*.md) - 必要に応じて新規作成docs/design/)該当する設計書が存在する場合、以下を更新:
> **✅ 実装完了** (YYYY-MM-DD)
>
> 実装内容の簡潔な説明
該当する設計書が存在しない場合、既存の設計書（例: docs/design/cache-api.md）のフォーマットに従って新規作成:
# <機能名> 設計書
## 実装ステータス
> **✅ 実装完了** (YYYY-MM-DD)
> 実装内容の説明
## 1. 概要
### 1.1 目的
### 1.2 スコープ
### 1.3 設計原則
## 2. API仕様
## 3. 実装詳細
docs/impl/)該当する実装計画書が存在する場合:
docs/streamlit-api-comparison.md)新しくAPIが実装された場合:
❌ → ✅ に変更kantan-ui カラムに kt.<api_name> を記入- に変更実装済み を追記README.md (英語)現在のREADMEは以下の構造を持つ。更新箇所を特定して必要なセクションのみ更新する:
新しいAPIやウィジェットが実装された場合:
APIリファレンスの記述フォーマット（既存パターンに従う）:
### API名
```typescript
kt.api_name(param1: Type1, param2?: Type2): ReturnType
```
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| param1 | `Type1` | - | 説明 |
| param2 | `Type2` | `default` | 説明 |
```typescript
// Usage example
kt.api_name("value");
```
APIのシグネチャやパラメータが変更された場合:
src/kt/) と一致させるREADME内のコード例が最新のAPIで動作するか確認:
src/index.ts のエクスポートと一致しているかkantan-ui からのインポート）docs/TUTORIAL.md (日本語)現在のチュートリアルは以下のセクションで構成されている:
既存のウィジェットやAPIが変更された場合:
新しいAPIカテゴリが追加された場合、既存セクションのフォーマットに従って追加する。
### <ウィジェット名>
`kt.<widget_name>()` は<説明>。
```typescript
const value = kt.<widget_name>("ラベル", options);
kt.write(`選択値: ${value}`);
```
**オプション:**
| パラメータ | 型 | デフォルト | 説明 |
|-----------|------|---------|------|
| label | `string` | - | ラベル |
| options | `object` | `{}` | 設定 |
目次に新しい項目を追加し、セクションを作成する:
---
## <新セクション名>
<概要説明>
### 基本的な使い方
```typescript
import { createApp, kt } from "kantan-ui";
const script = () => {
// コード例
};
export default await createApp(script);
```
実践セクション（カウンター、TODO、チャット）に新機能を活用した例を追加できる場合は更新する。ただし、既存の動作例を壊さないよう注意する。
セクションを追加・削除した場合、冒頭の目次を更新する。
すべてのドキュメントを更新した後、以下を確認:
src/kt/index.ts でエクスポートされている全APIがREADMEに記載されているかREADME.md は英語で記述するdocs/TUTORIAL.md と開発ドキュメントは日本語で記述するdocs/archive/ に移動する