‹ 首页

document-review

@sammyjoyce · 收录于 昨天 · 上游提交 2 个月前

This skill should be used to refine brainstorm or plan documents before proceeding to the next workflow step. It applies when a brainstorm or plan document exists and the user wants to improve it.

适合你,如果你有草稿需要打磨后再进入下一步

/ 通过 npx 安装 校验哈希
npx oh-my-skill add sammyjoyce/pi-compound-engineering/document-review
/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- sammyjoyce/pi-compound-engineering/document-review
/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify sammyjoyce/pi-compound-engineering/document-review
安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
0GitHub stars
~670上下文体积 · 单文件
索引托管

怎么用

技能原文 SKILL.md作者撰写 · MIT · b4eff36

Document Review

Improve brainstorm or plan documents through structured review.

Step 1: Get the Document

If a document path is provided: Read it, then proceed to Step 2.

If no document is specified: Ask which document to review, or look for the most recent brainstorm/plan in docs/brainstorms/ or docs/plans/.

Step 2: Assess

Read through the document and ask:

  • What is unclear?
  • What is unnecessary?
  • What decision is being avoided?
  • What assumptions are unstated?
  • Where could scope accidentally expand?

These questions surface issues. Don't fix yet—just note what you find.

Step 3: Evaluate

Score the document against these criteria:

| Criterion | What to Check | |-----------|---------------| | Clarity | Problem statement is clear, no vague language ("probably," "consider," "try to") | | Completeness | Required sections present, constraints stated, open questions flagged | | Specificity | Concrete enough for next step (brainstorm → can plan, plan → can implement) | | YAGNI | No hypothetical features, simplest approach chosen |

If invoked within a workflow (after /workflows:brainstorm or /workflows:plan), also check:

  • User intent fidelity — Document reflects what was discussed, assumptions validated
Step 4: Identify the Critical Improvement

Among everything found in Steps 2-3, does one issue stand out? If something would significantly improve the document's quality, this is the "must address" item. Highlight it prominently.

Step 5: Make Changes

Present your findings, then:

  1. Auto-fix minor issues (vague language, formatting) without asking
  2. Ask approval before substantive changes (restructuring, removing sections, changing meaning)
  3. Update the document inline—no separate files, no metadata sections
Simplification Guidance

Simplification is purposeful removal of unnecessary complexity, not shortening for its own sake.

Simplify when:

  • Content serves hypothetical future needs, not current ones
  • Sections repeat information already covered elsewhere
  • Detail exceeds what's needed to take the next step
  • Abstractions or structure add overhead without clarity

Don't simplify:

  • Constraints or edge cases that affect implementation
  • Rationale that explains why alternatives were rejected
  • Open questions that need resolution
Step 6: Offer Next Action

After changes are complete, ask:

  1. Refine again - Another review pass
  2. Review complete - Document is ready
Iteration Guidance

After 2 refinement passes, recommend completion—diminishing returns are likely. But if the user wants to continue, allow it.

Return control to the caller (workflow or user) after selection.

What NOT to Do
  • Do not rewrite the entire document
  • Do not add new sections or requirements the user didn't discuss
  • Do not over-engineer or add complexity
  • Do not create separate review files or add metadata sections
按 MIT 许可原样转载,未经改动 · 在 GitHub 查看 →

评论

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。