post-impl-docs
コードと同期したドキュメントを維持
ドキュメントはコード変更と同期しなくなることがよくあります。このスキルは、実装された変更を反映するために、README、CHANGELOG、docsフォルダ、インラインのdocstringを自動的に更新します。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「post-impl-docs」を使用しています。 Run post-impl-docs to update documentation after implementing a new user authentication feature
期待される結果:
Documentation updated successfully:
README.md:
- Added "User Authentication" to Features section
- Added `authenticate_user()` to API section
CHANGELOG.md:
- Added `feat:` entry for user authentication endpoint
docstrings:
- Updated 3 function docstrings
Files modified: 5
「post-impl-docs」を使用しています。 Update documentation for a bug fix that changes error handling behavior
期待される結果:
Documentation update summary:
CHANGELOG.md:
- Added `fix:` entry for error handling improvement
docstrings:
- Updated `ValueError` raises documentation in 2 functions
README.md: No changes needed (internal fix)
docs/: No references affected
セキュリティ監査
低リスクDocumentation skill containing cookbook reference material. All static findings are false positives - the skill contains markdown documentation with git command examples, changelog format references, and placeholder code blocks that triggered pattern matching but pose no security risk.
リスク要因
品質スコア
作れるもの
正確なCHANGELOGを維持
機能や修正を実装した後、従来のコミット標準に従って適切にフォーマットされたchangelogエントリを自動的に追加します。
READMEを同期させる
新しいコードがコードベースに追加されたときに、README.md内の機能リスト、APIセクション、使用例を更新します。
インラインドキュメントを更新
docstringをコード変更と同期させ、関数の説明、パラメータ、戻り値が正確なままであることを保証します。
これらのプロンプトを試す
Update documentation after the recent implementation. Analyze the git diff to understand what changed. Update README.md with any new features, add changelog entries to CHANGELOG.md, and update docstrings for modified functions.
Document a breaking change. Update README migration guides, add breaking change notice to CHANGELOG, update all affected docstrings, and flag documentation in docs/ folder for review.
Add documentation for new API endpoints. Update README API section, add usage examples, create docstrings for new functions, and add corresponding CHANGELOG entry.
Perform comprehensive documentation review. Analyze all changed files, update docs/ references to changed symbols, verify docstring accuracy, and generate a complete documentation update report.
ベストプラクティス
- 実装完了後、コミット前にこのスキルを実行して、ドキュメントが最新であることを確認する
- CHANGELOG_FORMAT変数をプロジェクトのchangelogスタイル(conventional、keep-a-changelog、またはsimple)に合わせて設定する
- COMMIT_DOCS=trueに設定して、ドキュメント変更をコードと一緒に自動的にコミットする
回避
- 実際のコード変更を分析せずにドキュメント更新を実行する
- タイポ修正のような些細な変更にCHANGELOGエントリを追加する
- 関数の動作が実際に変更されたかを検証せずにdocstringを更新する