القائمة
Update docs when code changes — reviews commits and syncs user-facing documentation
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Verify understanding after implementation with targeted quizzes
Clarify requirements through targeted questions — uncovers unknown unknowns in specs
Remove AI-generated code patterns that don't match codebase style
Review code for quality, security, and best practices — read-only analysis
Create clear documentation for code and APIs
Audit code for security vulnerabilities — read-only analysis
| name | docs-update |
| description | Update docs when code changes — reviews commits and syncs user-facing documentation |
| license | MIT |
| compatibility | cline, claude, opencode, amp, codex, gemini, cursor, pi |
| hint | Use when updating documentation, reviewing docs, or handling documentation changes after code changes |
| user-invocable | true |
| disable-model-invocation | true |
| metadata | {"audience":"all","workflow":"documentation"} |
Automatically review code changes and update user-facing documentation to keep it synchronized with the codebase. Works across documentation platforms (Mintlify, Docusaurus, GitBook, Fumadocs, etc.) and supports both monorepo and multi-repo setups.
Determine which commits need documentation updates:
Filter for significant changes:
Skip documentation for:
Be conservative: quality over quantity. When in doubt about significance, skip the update.
Locate documentation:
Identify documentation platform: Determine the platform by examining configuration files and directory structure (e.g., Mintlify, Docusaurus, GitBook, Fumadocs, or generic markdown).
Understand documentation style: Read several existing documentation files to identify tone, voice, structure, code example patterns, terminology, and formatting conventions. Check for style guides or contribution documentation.
Map code changes to documentation needs (new content, modifications, or additions to existing content).
Guidelines:
Match existing style:
Testing mode (when user asks to "see what would change"):
Output a text summary describing:
Execution mode (when running as automation):
Create a descriptive branch name (e.g., docs/auto-update-YYYYMMDD)
Make documentation changes to appropriate files
Push branch and create PR with description linking to relevant commits:
When source code and documentation are in separate repositories, identify changes in the source repo, then switch to the docs repo and follow the workflow above. Reference source commits in the PR description.
