grill-with-docs

Validates project plans against CONTEXT.md glossaries and ADRs to catch terminology mismatches.

88|9|Updated Jul 16, 2020
One-click install
npx skills add https://github.com/docs-plus/docs.plus --skill grill-with-docs-docs-plus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: grill-with-docs
Source: https://github.com/docs-plus/docs.plus/tree/main/.agents/skills/grill-with-docs
Command: npx skills add https://github.com/docs-plus/docs.plus --skill grill-with-docs-docs-plus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of plans that conflict with your project's existing domain terminology, undocumented architectural decisions, or contradictions between proposed work and current codebase state, which can lead to wasted effort, inconsistent implementation, and repeated rework of already-solved problems.

Core Features & Use Cases

  • Domain alignment checks: Cross-reference planned work against your project's CONTEXT.md glossary and existing ADRs to catch terminology mismatches and conflicting design choices early in the planning process.
  • Terminology sharpening: Identify vague or overloaded terms in your plan and propose precise, consistent canonical terms aligned with your project's existing language to eliminate cross-team ambiguity.
  • Use case: When designing a new order processing feature for an e-commerce platform, use this Skill to ensure terms like "cancellation" and "refund" are used consistently with your existing domain definitions, and that your planned architecture doesn't contradict prior decisions about order state management.

Quick Start

Use the grill-with-docs skill to stress-test your new order processing feature plan against the project's existing domain glossary and ADRs, and update the documentation with any resolved terminology or architectural decisions as you work through the guided questions.

Frequently Asked Questions about grill-with-docs

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

FAQPage Schema
How do I validate a feature plan against existing ADRs and domain documentation?

To validate a feature plan against ADRs and domain documentation, cross-reference the proposed design against your project's CONTEXT.md glossary and docs/adr/ directory to catch terminology mismatches and conflicting architectural decisions before implementation begins.

What is domain terminology alignment and why does it matter for software planning?

Domain terminology alignment ensures planned features use canonical terms consistently with existing project definitions, preventing cross-team ambiguity and eliminating the rework caused by vague or overloaded language conflicting with established domain glossaries.

How do I check if my new architecture plan conflicts with previous architectural decisions?

Checking for architectural conflicts involves cross-referencing your new plan against existing architectural decision records in the docs/adr/ directory to identify and resolve any contradictions with documented prior design choices before implementation starts.

Do I need a CONTEXT.md file to validate project plans against domain docs?

Yes, validating project plans requires access to the project's codebase, a CONTEXT.md or CONTEXT-MAP.md file for glossary definitions, and a docs/adr/ directory to successfully cross-reference proposed work against existing documented context and architectural decisions.

What's the best way to catch terminology mismatches before code implementation begins?

The best way to catch terminology mismatches before implementation is to stress-test plans against existing domain glossaries, identifying vague terms and proposing precise canonical definitions aligned with the project's current documented domain language.

When should I not use automated plan validation against project documentation?

Plan validation against documentation is not suitable when a project lacks established CONTEXT.md glossaries or a docs/adr/ directory, as there is no existing documented context or architectural decisions available to cross-reference for mismatch detection.