skills.rest
pcasaretto
pcasarettoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-review

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

Updated Jun 28, 2022
Search Tags:#planning#refinement#brainstorming#editing#clarity#document review
One-click install
npx skills add https://github.com/pcasaretto/nix-home --skill document-review-pcasaretto
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-review
Source: https://github.com/pcasaretto/nix-home/tree/main/home-manager/modules/common/pi/compound-engineering/skills/document-review
Command: npx skills add https://github.com/pcasaretto/nix-home --skill document-review-pcasaretto

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of producing clear, concise, and actionable documents by providing a structured review process to identify and rectify ambiguities, inefficiencies, and unstated assumptions.

Core Features & Use Cases

  • Structured Assessment: Analyzes documents against criteria for clarity, completeness, and specificity.
  • Critical Improvement Identification: Pinpoints the single most impactful change needed.
  • Automated & Approved Edits: Handles minor fixes automatically and seeks approval for substantive changes.
  • Use Case: Before a major project kickoff, use this Skill to review the project proposal document, ensuring all stakeholders understand the objectives and scope, and that no critical details are overlooked.

Quick Start

Review the document located at /docs/plans/project-alpha-plan.md for clarity and completeness.

Frequently Asked Questions about document-review

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

FAQPage Schema
How do I refine a brainstorm or plan document for clarity and completeness?▼

Document review involves analyzing your plan against criteria for clarity, completeness, specificity, and YAGNI principles. This Skill pinpoints the most critical improvement needed and applies both automated minor fixes and approved substantive changes to enhance overall quality.

What is the best way to review a project proposal before kickoff?▼

The best way to review a project proposal before kickoff is using a structured assessment that checks for ambiguities and unstated assumptions. This process ensures stakeholders understand the objectives and scope while verifying no critical details are overlooked.

How do I edit planning documents to adhere to YAGNI principles?▼

Editing planning documents to adhere to YAGNI principles involves evaluating the text for unnecessary scope creep. This Skill assesses your document against YAGNI criteria, identifies critical improvements, and applies automated or approved changes to streamline the plan.

Can I automatically fix ambiguities in my brainstorm documents?▼

Yes, you can automatically fix ambiguities in brainstorm documents through a structured review process. This Skill handles minor fixes automatically and seeks your approval for substantive changes to rectify inefficiencies and enhance specificity.

Does document review work on specific file paths or only recent files?▼

Document review works on both specific file paths and recent files. You can direct the review to operate on documents within specified paths, or the process will automatically target the most recent brainstorm or plan files in your environment.

Related Skills

Explore More Content & Communication Skills→
praburajasekaranpraburajasekaran

document-review

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

Community
Intermediate
Tubular-HealthTubular-Health
1

define

Create precise issue specifications for Linear or Jira through structured Socratic questioning.

Official
Advanced
vzcovzco
15

make-signature

Generate durable byte signatures to locate functions across binary updates.

Official
Advanced
udecodeudecode
240

document-review

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

Official
Intermediate