mcpField
U
update-docs

update-docs

github.com/anyproto開発9.0k39 回インストール6 日前に更新
リポジトリ

update-docs について

コード変更に合わせてフォルダーごとの README を保守するスキルです。変更のあった箇所だけを正確かつ最小限に更新する手順を示します。

主な機能

  1. 01対象フォルダーの特定
  2. 02README と変更内容の比較
  3. 03関連セクションのみ更新
  4. 04ファイル名と件数の確認

活用シーン

  1. 01追加ファイルの説明を記載
  2. 02大きなコンポーネント変更後の更新
  3. 03古い README 項目の削除

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/anyproto/anytype-ts --skill update-docs

インストール後、Claude Code で/update-docsを入力して読み込まれたか確認します。

詳細

ドキュメント更新スキル

コードを変更したフォルダーにあるREADME.mdファイルを更新します。ドキュメントは、説明するコードの隣に配置します。各コンポーネント／抽象化フォルダーには、それぞれREADMEがあります。

使用するタイミング

次の場合にこのスキルを使用します。

  • ユーザーから変更後のドキュメント更新を明示的に依頼された場合
  • コンポーネント／抽象化フォルダー内のファイルを追加、削除、または大幅に変更するタスクが完了した場合

原則

  1. コードと同じ場所に配置 — READMEは説明対象のフォルダーに配置します
  2. 簡潔に — フォルダーの目的、構成、パターンを開発者が理解するのに役立つ内容だけを記載します
  3. 正確に — ファイル名、サイズ、型の数、説明を正確に記載します
  4. コンパクトに — 冗長な文章は避けます。表、箇条書き、コードスニペットを使用します
  5. 差分を重視 — 変更の影響を受けるセクションだけを更新します。無関係な内容は書き直しません

READMEの構成規約

各フォルダーのREADMEは、次のひな形に沿います（関連するセクションのみ含めます）。

# folder-name/ - Short Purpose

One-sentence overview. Contains **N files**.

## Architecture
[Only if the folder has a non-obvious entry point, router, or coordination pattern]

## Components / Modules / Types
[Table or bullet list of files with one-line descriptions]

## Pattern
[Code snippet showing the common pattern, if one exists]

ドキュメントに記載する内容

変更の種類ドキュメントでの対応
新しいファイルの追加ファイル一覧に1行の説明とともに追加
ファイルの削除ファイル一覧から削除
ファイル名の変更該当する項目を更新
新しいパターンの導入パターンのセクションを追加／更新
アーキテクチャの変更アーキテクチャのセクションを更新
ファイル数の変更概要行の数を更新
新しいブロック／メニュー／ポップアップの種類該当する種類の一覧に追加

ドキュメントに記載しない内容

  • コードを読めば明らかな実装の詳細
  • 関数レベルのAPIドキュメント（コードと型の役割です）
  • いつ何が変更されたかを記す変更履歴
  • TODO項目や今後の計画
  • ファイルごとに1文を超える説明
  • CLAUDE.mdにすでに記載されている重複情報

手順

  1. 影響を受けたフォルダーを特定する — ファイルが追加、削除、または大幅に変更されたフォルダーを確認します
  2. 既存のREADMEを読む — 影響を受けた各フォルダーにREADME.mdがあるか確認します
  3. 差分を確認する — 変更内容とREADMEの現在の記載を比較します
  4. 最小限の更新を行う — 影響を受ける行／セクションだけを編集します
  5. 正確性を確認する — ファイル名、数、説明が実際の内容と一致することを確認します

対象範囲のルール

  • コードが実際に変更されたフォルダーにあるREADMEだけを更新します
  • フォルダーにREADMEがなく、変更が重要な場合（新しいサブフォルダー、新しい抽象化レイヤーなど）は、規約に沿って作成します
  • 変更が軽微な場合（誤字の修正、小さなロジック変更など）は、ドキュメントの更新を省略します
  • このスキルではCLAUDE.mdを更新しません。このファイルには独自のメンテナンス手順があります

例

block/へのファイル追加
Change: Added `src/ts/component/block/ai.tsx`

Action: Edit `src/ts/component/block/README.md`
- Update file count in overview line
- Add entry under "Other Blocks":
  - `ai.tsx` - AI-generated content block
新しいストアの追加
Change: Added `src/ts/store/theme.ts`

Action: Edit `src/ts/store/README.md`
- Add row to the Stores table:
  | `theme.ts` | `S.Theme` | Theme management: color schemes, dark mode preferences |
menu/からのファイル削除
Change: Removed `src/ts/component/menu/legacySearch.tsx`

Action: Edit `src/ts/component/menu/README.md`
- Remove entry for legacySearch from the menu types list
- Update count if mentioned
新しいサブフォルダーの作成
Change: Created `src/ts/component/block/ai/` with index.tsx, toolbar.tsx, preview.tsx

Action: Create `src/ts/component/block/ai/README.md`:
  # ai/ - AI Content Block

  AI-generated content blocks with toolbar controls and preview. Contains **3 files**.

  ## Files
  - `index.tsx` - Main block component, renders AI content with edit/regenerate actions
  - `toolbar.tsx` - Prompt input and model selection toolbar
  - `preview.tsx` - Streaming preview of AI-generated content

Also update parent `src/ts/component/block/README.md` to reference the new subfolder.

コメント

Markdown 対応