vibe-review-docs
SKILL.md
Vibe Documentation Review Protocol
标准真源:
- 术语与默认动作语义以
docs/standards/glossary.md、docs/standards/action-verbs.md为准。 - Skill 与 Shell 边界以
docs/standards/skill-standard.md、docs/standards/command-standard.md、docs/standards/shell-capability-design.md为准。 - 触发时机与相邻 skill 分流以
docs/standards/skill-trigger-standard.md为准。 - 交付 flow / PR / worktree 语义若被提及,以
docs/standards/git-workflow-standard.md、docs/standards/worktree-lifecycle-standard.md为准。 - 文档角色与质量要求以
docs/README.md、docs/standards/doc-quality-standards.md为准。
核心职责: 文档概念审查(检查错误概念和过时信息)
使用场景:
- 入口文件审查: 检查 CLAUDE.md, SOUL.md, STRUCTURE.md 等入口文件
- docs/ 目录审查: 审计 docs/ 目录下的文档质量
- 概念对齐: 确保文档中的概念与代码实际状态一致
语义边界:
vibe-review-docs负责 docs、standards、task/readme、changelog 与入口文件的概念和表达审查。- 仅当对象是文档、标准、说明文字或文档治理问题时介入。
- source code diff、实现正确性与测试风险审查交给
vibe-review-code。
When invoked to review documentation, your goal is to ensure clarity, consistency, and alignment with the Vibe Center architecture layout.
1. Context Gathering (Align Truth)
- Identify Intent: Run
vibe flow review(Physical Tier 1) to determine the current state of documentation-heavy PRs. - Identify Files:
- Use
gh pr diff --name-onlyorgit diff main...HEAD --name-onlyand filter for\.md$. - For local docs review, combine
git diff --name-onlyandgit diff --cached --name-only, then filter for\.md$.
- Use
- Review Context: Check if
CHANGELOG.mdhas been reasonably updated by thevibe flow pr --bumpprocess.
2. Review Standards
Evaluate the documentation against the following checklist:
- Completeness: Are
docs/prds/following standard conventions (Background, Goals, Acceptance Criteria)? - Language & Clarity: Is the writing concise? Remove overly generic AI-speak ("In today's fast-paced digital world...").
- Accuracy: Do the documented CLI commands and architecture limits (e.g., 7000 LOC limit) match
CLAUDE.mdandDEVELOPER.md? - Git Constraints: Are we strictly distinguishing
.agents/(disposable global tools directory) from.agent/(managed project-specific workflows)?
3. Output: The Doc Review Report
Construct a structured report:
📄 Documentation Review Summary
Conclusion: [Approved / Needs Revisions]
🔴 Required Edits (Blockers)
- [File:Line] Detail what must be fixed (e.g. incorrect terminology, missing CHANGELOG entry).
🟡 Formatting & Clarity Suggestions
- [File:Line] Suggestions for better outline structure, markdown linting, or brevity.
Weekly Installs
1
Repository
jacobcy/vibe-co…l-centerFirst Seen
4 days ago
Security Audits
Installed on
mcpjam1
claude-code1
replit1
junie1
windsurf1
zencoder1