Update Docs

Use when implementing new features, changing behavior, or modifying the public API. Documents changes in README and relevant docs.

tomevault-io Updated

File contents

Documentation Update

ユーザー向け変更を発見可能にするため、変更種別に応じたドキュメント箇所を更新する。

Decision Matrix

変更種別 更新先
新 public API (型/関数/クラス) README.md (簡潔), mod.ts (export + JSDoc)
新機能 README.md, docs/usage.md
動作変更 README.md (既存記述更新), CHANGELOG.md
CLI変更 docs/breakdown/interface/cli_commands.ja.md
パス解決変更 docs/breakdown/interface/path_resolution.ja.md
設定変更 docs/breakdown/interface/configuration.ja.md
ドメイン設計変更 docs/breakdown/domain_core/ 配下
内部変更 CLAUDE.md (開発ワークフローに影響する場合のみ)

手順: git diff --name-only → 変更分類 → 該当ドキュメント更新 → コード例の動作確認。簡潔・例示優先・検索可能を守る。内部実装詳細・一時的ワークアラウンド・デバッグ専用オプションは記載しない。


Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/tettuan--breakdown--update-docs commit 9f9925767e

Frequently asked questions

npx skillmds@latest add tomevault-io/update-docs-4