skills.rest
andrewhwaller
andrewhwallerCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-review

Review brainstorm and plan documents for clarity, completeness, and YAGNI.

Updated May 20, 2022
Search Tags:#workflow#editing#plan#quality-check#brainstorm#document-review
One-click install
npx skills add https://github.com/andrewhwaller/dotfiles --skill document-review-andrewhwaller
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-review
Source: https://github.com/andrewhwaller/dotfiles/tree/main/opencode/skills/document-review
Command: npx skills add https://github.com/andrewhwaller/dotfiles --skill document-review-andrewhwaller

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Refine brainstorm or plan documents before proceeding to the next workflow step, reducing ambiguity and alignment risks by surfacing unclear language, omissions, and assumptions.

Core Features & Use Cases

  • Structured, stepwise review of documents to identify unclear points, unnecessary content, and unstated assumptions.
  • Evaluation of clarity, completeness, specificity, and adherence to scope (YAGNI) to guide next actions.
  • Optional iterative refinement and inline impact notes to prepare documents for downstream workflows such as brainstorming, planning, or execution.
  • Use Case: Given a brainstorm doc, the skill highlights gaps and suggests concrete improvements to increase actionability.

Quick Start

Supply the path to a brainstorm or plan document to begin the structured review.

Frequently Asked Questions about document-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a brainstorm document to find gaps and unstated assumptions?▼

Plan documents are evaluated against clarity, completeness, specificity, and YAGNI scope adherence. The skill enforces these criteria to assess quality, highlight gaps, and guide improvements, ensuring the plan is ready for downstream execution workflows.

How do I check if my project plan meets quality criteria before execution?▼

Plan documents are evaluated against clarity, completeness, specificity, and YAGNI scope adherence. The skill enforces these criteria to assess quality, highlight gaps, and guide improvements, ensuring the plan is ready for downstream execution workflows.

Can I refine planning documents iteratively to prepare for downstream workflows?▼

Planning documents can be refined iteratively to prepare for downstream workflows. The skill offers optional iterative refinement and inline impact notes, addressing ambiguity and alignment risks before proceeding to the next workflow step like execution.

What is the best way to apply YAGNI scope checks to project plans?▼

Applying YAGNI scope checks to plans involves evaluating adherence to scope and removing unnecessary content. The skill enforces YAGNI criteria during its structured review to identify out-of-scope items and guide improvements for cleaner execution.

Does the document review skill work with files in specific directories like docs/plans?▼

The document review skill works with brainstorming and planning documents across projects, including those in docs/brainstorms or docs/plans directories. You simply supply the path to your document to begin the structured review process.

Related Skills

Explore More Content & Communication Skills→
staruhubstaruhub
662

request-analyzer

Analyze user requests to score clarity, specificity, and completeness and recommend skill activations.

Community
Intermediate
FerroxLabsFerroxLabs
21

ferrox-discuss-phase

Extract unresolved implementation decisions and synthesize a phase-specific CONTEXT.md.

Community
Advanced
0xmariowu0xmariowu
4

idea

Clarify fuzzy product or engineering ideas into problem statements and success criteria.

Community
Basic
praburajasekaranpraburajasekaran

document-review

Review brainstorm or plan documents for clarity, completeness, specificity, and YAGNI adherence.

Community
Intermediate