plan-document-review

Name: plan-document-review
Availability: InStock
Author: GrowingIO

Validate planning documents for completeness, accuracy, and consistency.

91|37|Updated Jul 31, 2020

Search Tags:#documentation #project planning #impact analysis #API validation #plan review

Ready to run

npx skills add https://github.com/growingio/growingio-sdk-ios-autotracker --skill plan-document-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: plan-document-review
Source: https://github.com/growingio/growingio-sdk-ios-autotracker/tree/main/.agents/skills/plan-document-review
Command: npx skills add https://github.com/growingio/growingio-sdk-ios-autotracker --skill plan-document-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps validate the completeness and quality of planning documents, ensuring all necessary sections and impact analysis are included before proceeding.

Core Features & Use Cases

Comprehensive Review: Checks whether the planning content contains all key sections such as impact files, API changes, data protocols, and documentation updates.
Consistency Verification: Ensures listed impact files exist and changes are accurately documented, including API signatures and protocol details.
Use Case: A product team drafts a new feature plan in docs/. This Skill reviews the plan, verifies completeness and consistency, and recommends improvements to meet engineering standards.

Quick Start

Use the plan review skill to validate the latest planning document located at docs/plans/feature-x.md.

Frequently Asked Questions about plan-document-review

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

FAQPage Schema

How do I validate the completeness of a project planning document for engineering review?▼

API validation in planning documents verifies API signature accuracy and confirms that documented changes match the actual API specifications. This ensures consistency and prevents implementation errors by enforcing strict accuracy across your project plans.

What sections are required in a feature plan before passing an impact analysis review?▼

You can review planning documents stored as markdown files, such as those located in a docs directory. The tool validates the content consistency and completeness of these documentation files to ensure they are ready for implementation workflows.

Does documentation synchronization work with API updates during plan review?▼

Documentation synchronization is a core part of the plan review process, ensuring that API updates and protocol details are accurately reflected. The review verifies consistency between listed impact files and the documented changes to maintain accuracy.

What happens if impact files listed in a project plan do not exist?▼

The primary limitation is that it strictly enforces completeness and consistency, meaning any missing sections, inaccurate API signatures, or absent impact files will cause the review to recommend improvements before the document meets engineering standards.