菜单
Check if documentation is up to date with code changes. Analyzes git changes and identifies documentation that may need updating, comparing code modifications against reference docs and package READMEs.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Run a comprehensive review of the Queuert library before publishing, launching 10 parallel agents to check documentation coherence, API design, implementation verification, feature completeness, API consistency, schema design, code style, benchmarks, changeset coverage, and OTEL semantic conventions. Use when preparing to publish or validating publish readiness.
Run a comprehensive code review of local changes, analyzing staged and unstaged changes to provide insights, identify issues, and suggest alternative approaches. Use when reviewing code before committing or creating pull requests.
Create a release for the Queuert monorepo. Guides through changeset creation, version bumping, committing, merging dev to main, tagging, and creating a GitHub prerelease.
Generate a conventional commit message from staged changes. Analyzes changes to determine affected packages and appropriate commit type, then outputs a properly formatted commit message.
Identify flaky tests by running tests multiple times and analyzing intermittent failures. Use when investigating test reliability.
| name | docs-check |
| description | Check if documentation is up to date with code changes. Analyzes git changes and identifies documentation that may need updating, comparing code modifications against reference docs and package READMEs. |
Analyze git changes to identify documentation that may need updating. This skill compares code modifications against reference docs (docs/src/content/docs/advanced/) and package READMEs to ensure documentation stays in sync with the codebase.
When this skill is invoked:
.claude/agents/docs-check/instructions.md/docs-check # Check all uncommitted changes
/docs-check --staged # Check only staged changes
/docs-check <commit> # Check changes in a specific commit
/docs-check <base>..<head> # Check changes between commits
Based on arguments:
git diff HEAD (all uncommitted changes)--staged: git diff --staged<commit>: git show <commit><base>..<head>: git diff <base>..<head>Also run git diff --name-only (with appropriate flags) to get the list of changed files.
Group changes by their documentation relevance:
| File Pattern | Related Documentation |
|---|---|
packages/*/src/** | TSDoc on exports, package README, relevant reference docs in docs/src/content/docs/advanced/ |
examples/** | Package READMEs, CLAUDE.md |
| Exports/public API | TSDoc on exports, package README, CLAUDE.md |
Look in docs/src/content/docs/advanced/ to identify which reference docs are relevant for a given package or subsystem.
For each category of changes, determine:
Read relevant documentation files and compare against code changes:
Provide a structured report categorizing findings by urgency.
# Documentation Sync Check
## Summary
[Brief overview of changes and documentation status]
## Changes Analyzed
- [List of changed files grouped by area]
## Documentation Updates Required
### Must Update
[Documentation that is definitely out of sync - factually incorrect, missing new features, wrong API signatures]
### Should Review
[Documentation that may need updating - behavioral changes, new edge cases, terminology]
### Already Up to Date
[Documentation that was checked and appears current]
## Specific Recommendations
### [doc-file-path]
- **Issue**: [What's wrong or missing]
- **Code Reference**: [Which code change necessitates this]
- **Suggested Action**: [What to update]
## No Documentation Impact
[Changes that don't require documentation updates and why]
MUST UPDATE: Documentation is factually incorrect or missing critical information
SHOULD REVIEW: Documentation may be stale or incomplete
NO IMPACT: Changes that don't affect documentation