document-review

Name: document-review
Availability: InStock
Author: Udecode

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

240|75|Updated Jul 13, 2023

Search Tags:#planning #refinement #brainstorming #editing #clarity #document review

Ready to run

npx skills add https://github.com/udecode/plate-playground-template --skill document-review-udecode

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-review
Source: https://github.com/udecode/plate-playground-template/tree/main/.codex/skills/document-review
Command: npx skills add https://github.com/udecode/plate-playground-template --skill document-review-udecode

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the challenge of producing clear, complete, and actionable documents by providing a structured review process to identify and rectify ambiguities, unnecessary content, and unstated assumptions.

Core Features & Use Cases

Structured Assessment: Evaluates documents against criteria for clarity, completeness, specificity, and adherence to YAGNI principles.
Critical Improvement Identification: Pinpoints the single most impactful change needed for document quality.
Automated & Guided Edits: Handles minor fixes automatically and seeks approval for substantive changes.
Use Case: Before submitting a project plan, use this skill to ensure all requirements are clearly stated, potential scope creep is identified, and the plan is specific enough for the development team to begin work.

Quick Start

Review the document located at 'docs/plans/project-alpha-plan.md' to identify areas for improvement.

Frequently Asked Questions about document-review

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

FAQPage Schema

What is a structured document review process for project plans?▼

A structured document review evaluates brainstorm or plan documents for clarity, completeness, specificity, and adherence to the YAGNI principle. It identifies critical improvements and facilitates guided edits to enhance document quality and actionability.

How do I refine a project plan for clarity and impact before development?▼

Refine a project plan by assessing it against criteria for clarity and completeness, pinpointing the single most impactful change needed, and applying guided edits to ensure requirements are clearly stated for the development team.

How does an automated editing process handle substantive document changes?▼

Automated editing handles minor fixes automatically, while seeking approval for substantive changes. It identifies unstated assumptions and rectifies ambiguities to produce a more actionable document without overriding author intent.

When do I need to review a document for the YAGNI principle?▼

You need to review a document for the YAGNI principle when preparing a project plan to identify potential scope creep, eliminate unnecessary content, and ensure the plan is specific enough for workflow progression.

Can I identify scope creep and unstated assumptions in a brainstorm document?▼

Yes, you can identify scope creep and unstated assumptions in a brainstorm document through a structured assessment that evaluates specificity and completeness, rectifying ambiguities to ensure all requirements are clearly stated.