check-plan

Validate architectural decision records and issue prompts against version-locked criteria.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/olivermorgan2/workflow-generator --skill check-plan-olivermorgan2
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-plan
Source: https://github.com/olivermorgan2/workflow-generator/tree/main/skills/check-plan
Command: npx skills add https://github.com/olivermorgan2/workflow-generator --skill check-plan-olivermorgan2

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill prevents low-quality documentation and poorly scoped tasks from entering your project by enforcing structural and content-based criteria before any changes are committed to disk.

Core Features & Use Cases

  • Automated Quality Gate: Validates ADRs and issue prompts against version-locked criteria to ensure they meet project standards.
  • Iterative Feedback Loop: Provides specific, actionable revisions for failed criteria and supports an interactive correction process.
  • Use Case: When drafting a new architectural decision, this skill automatically checks that your ADR includes all required sections and clearly defined options, preventing incomplete records from being saved.

Quick Start

Run the check-plan skill on your draft ADR file to validate its structure and content against the project criteria.

Frequently Asked Questions about check-plan

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

FAQPage Schema
How do I validate architectural decision records before committing them to a repository?

You can validate architectural decision records by running an automated quality gate that checks markdown files against predefined structural and content criteria, ensuring incomplete ADRs are never committed to your project workflow.

What is the best way to enforce structural consistency for GitHub issue prompts?

Enforcing structural consistency for issue prompts requires a pre-commit validation gate that deterministically evaluates markdown content against a version-locked criteria set, providing actionable feedback to guide iterative revisions.

Can I use a pre-commit hook to check that my ADR includes required sections and clearly defined options?

Yes, you can use a pre-commit documentation gate to check your ADR, validating that required sections and options are present and preventing incomplete records from being saved to disk.

How do I get actionable feedback when an ADR or issue prompt fails documentation quality checks?

When an ADR or issue prompt fails validation, the quality gate provides specific, actionable revisions for the failed criteria and supports an interactive correction process to fix the markdown content.

Does automated ADR validation require a specific criteria set to function properly?

Yes, automated ADR validation requires a version-locked criteria set to function properly, enabling deterministic evaluation of markdown files to ensure consistency and completeness across project artefacts.

When should I not use automated documentation gates for markdown validation?

You should avoid automated documentation gates when your markdown files do not require strict structural consistency or when your project workflow lacks a version-locked criteria set for deterministic evaluation.