메뉴
コード変更、API変更、新機能追加時にドキュメントを自動更新します。公開APIやインターフェースの変更、新クラス・関数・モジュールの追加、アーキテクチャの重要な変更、ユーザーからの明示的なドキュメント更新依頼時に起動します。プロジェクトのドキュメント標準に準拠した更新を提案します。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | doc-updater |
| description | コード変更、API変更、新機能追加時にドキュメントを自動更新します。公開APIやインターフェースの変更、新クラス・関数・モジュールの追加、アーキテクチャの重要な変更、ユーザーからの明示的なドキュメント更新依頼時に起動します。プロジェクトのドキュメント標準に準拠した更新を提案します。 |
| allowed-tools | Read Edit Write Glob Grep Bash |
このスキルは、コードベースの変更に応じてプロジェクトのドキュメントを自動的に更新・同期します。
以下の状況で自動的に起動します：
まず、以下の情報を収集します：
プロジェクトのドキュメント構成を分析し、更新が必要なファイルを特定：
docs/index.md または README.md: クイックスタート、概要docs/architecture.md: アーキテクチャ設計docs/how-it-works.md: 動作原理ドキュメント作成ガイドラインは .claude/docs.md を参照してください。
重要なポイント：
更新内容を提示し、以下を確認：
承認後、以下を実行：
最後にドキュメントビルドでエラーがないことを確認します。
プロジェクトで使用しているドキュメンテーションシステムに応じて：
# 例: Sphinx
sphinx-build -M html docs docs/_build
# 例: MkDocs
mkdocs build
# 例: その他
# プロジェクト固有のビルドコマンド
変更内容:
class StreamingModel:
"""ストリーミング対応のモデル"""
def __init__(self, model_name: str):
...
async def stream(self, messages: list[dict]) -> AsyncIterator[str]:
...
スキルの動作:
docs/architecture.mdにストリーミングモデルのセクションを追加docs/how-it-works.mdにストリーミングの仕組みを説明docs/index.mdのクイックスタートにストリーミングの使用例を追加変更内容:
# 変更前
def __init__(self, model_name: str):
...
# 変更後
def __init__(self, model_name: str, timeout: int = 30, max_retries: int = 3):
...
スキルの動作:
docs/index.mdのクイックスタート例を更新変更内容:
ToolExecutorクラスを導入スキルの動作:
docs/architecture.mdのアーキテクチャ図を更新重要: 詳細なドキュメント作成ガイドラインは .claude/docs.md を参照してください。
このファイルには以下の情報が含まれています：
作業進捗をGitHub issueに自動報告します。計画立案時、知見獲得時、問題発覚時にブランチ名からissue番号を抽出し、構造化されたコメントを投稿します。
note.com APIの調査を支援します。mitmproxyとPlaywrightを使用してHTTPトラフィックをキャプチャ・分析し、API動作を解明します。
コード品質基準の完全遵守を保証します。コミット前の品質チェックを自動実行し、エラーがある状態でのコミットを防止します。
プロジェクト憲法への準拠を検証します。実装完了時やPR作成時に全Articleをチェックし、違反がないことを確認します。
MCPサーバー開発を支援します。プロトコル準拠、Pydanticスキーマ設計、Playwright統合のベストプラクティスを提供します。
TDDワークフローを強制し、テストファースト開発を支援します。新機能実装時に自動起動し、Red-Green-Refactorサイクルを確実に実行します。