agentleFS
Sign inStart free
thedigitalorganizerthedigitalorganizer/soloship/skills/document-review/SKILL.md

document-review

Skill0 starsChanged 5 months agoMITView on GitHub

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.

11 other projects use a version of this, 4 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup and skill-creator.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • VercelSkill

    setup

    Set up Vercel CLI and project configuration. Use when the user says "set up Vercel", "configure Vercel", "link to Vercel", or "vercel init".

    Also in 3 projects that use this

  • SentrySkill

    skill-creator

    Create new agent skills following the Agent Skills specification. Use when asked to "create a skill", "add a new skill", "write a skill", "make a skill", "build a skill", or scaffold a new skill with SKILL.md. Guides through requirements, writing, registration, and verification.

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 9 are common, 1 is distinctive, and 3 are very specific to this project.

  • 9

    Common

    Most of the 6 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If you are running this skill in Codex, read ../references/codex-compatibility.md before following host-specific tool instructions.

    line 8
  2. Common:

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

    line 28
  3. Very specific:

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

    line 30
  4. Common:

    Read through the document and ask:

    line 34
  5. Very specific:

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

    line 55
  6. Distinctive:

    Ask approval: before substantive changes (restructuring, removing sections, changing meaning)

    line 67
  7. Common:

    After changes are complete, ask:

    line 87
  8. Common:

    Review complete: - Document is ready

    line 90
  9. Common:

    After 2 refinement passes, recommend completion—diminishing returns are likely.

    line 94
  10. Common:

    Do not rewrite the entire document

    line 100
  11. Common:

    Do not add new sections or requirements the user didn't discuss

    line 101
  12. Common:

    Do not over-engineer or add complexity

    line 102
  13. Common:

    Do not create separate review files or add metadata sections

    line 103

“Common” is measured: kept by at least 6 in 10 of the 6 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Host Compatibility

If you are running this skill in Codex, read ../references/codex-compatibility.md before following host-specific tool instructions. Claude Code should continue to use the Claude-specific tools and command wrappers described here.

Model posture (Soloship)

See the auto-loaded model-mode rule. Standard posture (the default): execute this skill exactly as written. Fable posture (model id contains fable/mythos): every gate this skill names — evidence to produce, verifications to run, dispatches it mandates, user checkpoints — remains binding; its step ordering and procedural scaffolding are method guidance you may adapt when the work is better served. Never skip a step that produces evidence; when ambiguous, treat it as a gate.

<!-- Vendored from compound-engineering v2.34.0 (Kieran Klaassen). See skills/vendored/ce/LICENSE. -->

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/drafts/ 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:

CriterionWhat to Check
ClarityProblem statement is clear, no vague language ("probably," "consider," "try to")
CompletenessRequired sections present, constraints stated, open questions flagged
SpecificityConcrete enough for next step (brainstorm → can plan, plan → can implement)
YAGNINo hypothetical features, simplest approach chosen

If invoked within a workflow (after /soloship:brainstorm or /soloship: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.

Act on the selection in this same session: "Refine again" loops back to Step 2 for another pass; "Review complete" means the document is ready — confirm that to the user and continue with whatever workflow invoked this review, if any.

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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free