grill-with-docs

Validate project plans against domain models and update documentation files.

Updated Oct 25, 2021
One-click install
npx skills add https://github.com/liyier90/dotfiles --skill grill-with-docs-liyier90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: grill-with-docs
Source: https://github.com/liyier90/dotfiles/tree/main/dot_pi/agent/skills/grill-with-docs
Command: npx skills add https://github.com/liyier90/dotfiles --skill grill-with-docs-liyier90

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill enables you to challenge your project plan against an existing domain model, refine terminology, and update documentation (CONTEXT.md, ADRs) in real-time as decisions are made. It helps in ensuring clarity and alignment of terminology within your project.

Core Features & Use Cases

  • Domain Model Validation: Validate project plans against existing domain knowledge and terminology.
  • Real-time Documentation: Automatically update CONTEXT.md and ADRs during sessions for current terms and decisions.
  • Use Case: Use this Skill when planning new features or changes to existing ones, ensuring terminology and design align with current domain models.

Quick Start

Use the 'grill-with-docs' skill to begin your grilling session for a new feature proposal.

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 project plan against an existing domain model?

Validating a project plan against a domain model involves challenging proposed features against existing domain terminology, refining definitions, and updating CONTEXT.md inline to ensure design alignment.

How do I update ADRs and context documentation in real-time during design sessions?

Updating ADRs and context documentation in real-time happens automatically during grilling sessions, capturing architectural decision records and current terminology inline as design choices are made.

What is domain model validation and when do I need it for feature planning?

Domain model validation is the process of checking new feature plans against established domain knowledge. You need it during design and planning stages to ensure terminology and architecture align with current models.

Do I need existing domain terms and context files to use this design validation approach?

Yes, design validation requires pre-existing knowledge of domain terms and the ability to execute commands for code exploration, as it refines terminology by challenging plans against an existing domain model.

What is the best way to refine domain terminology and align it with architectural decisions?

The best way to refine domain terminology is to challenge project plans against existing context, capturing decisions in ADRs and updating CONTEXT.md inline to maintain alignment between terminology and architecture.