القائمة
Synchronize documentation with the current codebase. Fix drift between docs/prd.md, docs/system-design.md, and actual source code.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | doc-sync |
| description | Synchronize documentation with the current codebase. Fix drift between docs/prd.md, docs/system-design.md, and actual source code. |
| compatibility | ["claude-code","opencode","github-copilot"] |
| metadata | {"version":"1.0","author":"team"} |
Synchronize docs/prd.md and docs/system-design.md with the current codebase. Fix drift, add missing items, remove stale references.
Use the Explore agent to build a complete picture of what is implemented:
internal/ and root -- note every type, interface, function, fieldcmd/config.example.yaml, internal/config/)docs/adr/Capture: type names (exact casing), struct/interface fields (exact types), exported vs unexported visibility, package dependencies, pipeline step ordering, CLI arguments, configuration properties.
Read docs/prd.md, docs/system-design.md, and docs/documentation.md.
Compare the codebase snapshot against both documents. Identify:
In PRD:
In System Design:
Apply all fixes. Follow these rules strictly:
Document boundaries (from docs/documentation.md):
Writing standards (from CLAUDE.md):
Preservation rules:
Invoke the doc-reviewer agent with this preamble:
You are a read-only reviewer. Inspect files with Read, Glob, and Grep. Only permitted Bash commands:
make ci. Do not write code, scripts, or temporary files. Never use system/tmp; use.scratch/tmp/for any temporary output.
The reviewer validates against docs/documentation.md checklist:
Apply fixes for any [AUTOFIX] or [BLOCKED] issues the reviewer found. Re-run the reviewer if changes were substantial. Stop when the reviewer returns APPROVED.
Report a summary of changes made:
Architectural validation checklist for feature approval. Load when validating that features fit into the existing architecture.
Architecture Decision Record format, naming conventions, and when to create ADRs. Load when making or documenting architectural decisions.
Audit the agentic configuration for consistency, coherence, and conciseness. Load when modifying agent definitions, skills, or pipeline structure, or to verify cross-tool parity.
Build, test, format, and lint requirements that must pass before code review. Load when checking implementation completeness or running the quality gate.
Go code quality checklist based on Google Go Style Guide. Load when conducting code quality reviews.
Pre-commit safety checks for secrets, credentials, local settings, and sensitive file patterns. Load before committing or when reviewing staged changes for accidental exposure.