菜单
Comprehensive documentation review and update. Use before merging branches to ensure all docs are current, complete, and consistent.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | docs-update |
| description | Comprehensive documentation review and update. Use before merging branches to ensure all docs are current, complete, and consistent. |
| allowed-tools | Read, Glob, Grep, Edit, Write, WebSearch |
| context | fork |
| agent | user-docs |
Systematically review and update all user-facing documentation before merging a branch. This skill orchestrates the individual documentation skills into a complete pre-merge documentation audit.
Run this skill when:
Full documentation update:
/design-docs:docs-update
Update specific module only:
/design-docs:docs-update my-package
Review only (no changes):
/design-docs:docs-update --review-only
This skill follows a specific order to ensure consistency:
Run package.json review first - it's the source of truth for metadata.
# Internally runs: /design-docs:docs-review-package
Check:
Apply safe fixes for metadata issues identified in review.
Generate or update the package README.
# Internally runs: /design-docs:user-docs-create-readme
Ensure:
Generate or update contribution guide.
# Internally runs: /design-docs:docs-generate-contributing
Ensure:
Generate or update security policy.
# Internally runs: /design-docs:docs-generate-security
Ensure:
If design docs exist, generate repository documentation.
# Internally runs: /design-docs:docs-generate-repo (if applicable)
Ensure:
Check all internal links work:
Ensure version references are consistent:
Verify code examples:
After completion, provide a summary:
## Documentation Update Summary
### Files Updated
- ✅ README.md - Updated badges, refreshed features
- ✅ CONTRIBUTING.md - Updated Node version requirement
- ✅ SECURITY.md - No changes needed
- ⏭️ docs/ - Skipped (no design docs)
### Issues Found and Fixed
1. package.json: Added missing `bugs` field
2. README.md: Updated quick start example
3. CONTRIBUTING.md: Fixed incorrect pnpm version
### Issues Requiring Manual Review
1. README.md: Feature list may need human review
2. docs/api.md: Complex example needs verification
### Validation Results
- ✅ All internal links valid
- ✅ Version references consistent
- ⚠️ 1 example needs manual testing
This skill orchestrates:
/design-docs:docs-review-package — Package.json review/design-docs:user-docs-create-readme — README generation/design-docs:docs-generate-contributing — CONTRIBUTING.md generation/design-docs:docs-generate-security — SECURITY.md generation/design-docs:docs-generate-repo — Level 2 docs generation/design-docs:user-docs-review — Documentation quality reviewGenerate 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.