菜单
Sync user documentation with design doc changes. Use when design docs have been updated and user docs need to reflect the changes.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Generate cross-reference graph showing relationships between design documents. Use when visualizing doc dependencies, finding related docs, or understanding documentation structure.
Validate design doc structure and frontmatter. Use when checking design docs for compliance, ensuring proper formatting, or verifying metadata before commits.
Comprehensive quality audit for CLAUDE.md context files. Use when performing thorough quality checks, preparing for releases, ensuring context efficiency, or verifying token optimization.
Style rules for LLM context files (CLAUDE.md, AGENTS.md and their .local variants). Fires automatically when these files are opened. Enforces on-demand loading patterns, proper @-reference syntax and lean context structure.
Split large CLAUDE.md into child files. Use when context files exceed word limits, are too verbose, or cover multiple distinct topics that should be separate.
Validate CLAUDE.md structure, formatting, and quality. Use when checking context files for compliance, ensuring proper structure, or verifying before commits.
| name | docs-sync |
| description | Sync user documentation with design doc changes. Use when design docs have been updated and user docs need to reflect the changes. |
| allowed-tools | Read, Glob, Edit, Write |
| context | fork |
| agent | user-docs |
Syncs user documentation with changes in design docs to keep them current.
This skill detects changes in design docs and updates corresponding user documentation by:
Sync all levels for a module:
/design-docs:docs-sync effect-type-registry
Sync specific level only:
/design-docs:docs-sync rspress-plugin-api-extractor --level=1
Preview changes without writing:
/design-docs:docs-sync website --dry-run
module: Module to sync [REQUIRED]--level: Sync specific level (1=README, 2=repo, 3=site)--dry-run: Preview changes without writingCompare timestamps:
updated fieldFor each changed design doc:
Update strategies:
Protect user additions:
Mark synced docs with current timestamp.
instructions.md - Detailed sync processexamples.md - Sync scenarios and outputs.claude/design/design.config.jsondesignDocsPathuserDocs paths/design-docs:user-docs-create-readme - Regenerate README/design-docs:docs-generate-repo - Regenerate repo docs/design-docs:docs-generate-site - Regenerate site docs/design-docs:user-docs-review - Review sync quality