grill-with-docs

Validate design plans against a project's domain model and terminology.

1|Updated Aug 16, 2023
One-click install
npx skills add https://github.com/monlor/dotfiles --skill grill-with-docs-monlor
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: grill-with-docs
Source: https://github.com/monlor/dotfiles/tree/main/config/ai/agents/skills/grill-with-docs
Command: npx skills add https://github.com/monlor/dotfiles --skill grill-with-docs-monlor

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps ensure that your plans align with the domain model and terminology of your project, while also updating documentation inline as decisions are made.

Core Features & Use Cases

  • Domain Model Validation: Stress-test your plans against the existing domain model.
  • Terminology Clarification: Refine and clarify project terminology.
  • Documentation Update: Automatically update CONTEXT.md and ADRs as decisions crystallize.
  • Use Case: Use this Skill when developing a new feature to ensure your design matches the project's domain model and documented decisions.

Quick Start

Use the grill-with-docs skill to discuss a new feature with the domain model in mind.

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 new feature design against an existing domain model?▼

To validate a feature design against a domain model, you can stress-test your plans to ensure they align with the project's documented terminology and architecture. This clarifies terminology and updates documentation inline as decisions crystallize.

What is the best way to keep project documentation updated during iterative development?▼

Keeping documentation updated during iterative development is achieved by validating design plans against your domain model and automatically recording architectural decisions. This process updates files like CONTEXT.md and ADRs inline as decisions are made.

When do I need to clarify project terminology for software engineering?▼

You need to clarify project terminology when developing a new feature to ensure your design matches the project's domain model. It refines definitions and prevents inconsistencies between your implementation plans and documented decisions.

Do I need existing ADRs to validate design plans against a domain model?▼

You do not need existing ADRs to start validating design plans, but understanding your project-specific contexts is required. The process updates or creates ADRs and CONTEXT.md files automatically as your architectural decisions crystallize.

Why does my feature plan conflict with the project's domain model terminology?▼

Your feature plan conflicts with the domain model terminology because new designs often introduce inconsistent definitions. Clarifying terminology and stress-testing plans against the existing model resolves these discrepancies and updates the documentation.