grill-with-docs

Interrogates a plan against codebase and documented domain language to resolve ambiguities.

Updated May 17, 2022
One-click install
npx skills add https://github.com/kanade0404/dotfiles --skill grill-with-docs-kanade0404
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: grill-with-docs
Source: https://github.com/kanade0404/dotfiles/tree/main/.opencode/skills/grill-with-docs
Command: npx skills add https://github.com/kanade0404/dotfiles --skill grill-with-docs-kanade0404

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you pressure-test a plan against the existing codebase, glossary, and documented decisions so you can resolve ambiguity before making changes.

Core Features & Use Cases

  • Plan Interrogation: Asks one question at a time and walks through each branch of the design until the unresolved parts are clear.
  • Language Alignment: Detects terminology that conflicts with the current domain language and pushes for precise canonical terms.
  • Code and Docs Cross-Checking: Compares stated behavior against the repository and surfaces contradictions immediately.
  • Inline Documentation Updates: Records resolved terms in CONTEXT.md and suggests ADRs when a decision is hard to reverse, surprising, and trade-off driven.

Quick Start

Ask this skill to review your plan against the repository and guide a step-by-step grilling session that updates the relevant documentation as decisions are resolved.

Frequently Asked Questions about grill-with-docs

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

FAQPage Schema
How do I stress-test a design plan against an existing codebase and documentation?

To stress-test a design plan, interrogate it against the existing codebase and documented domain language to resolve ambiguous design decisions. This process cross-references source code and docs to validate trade-offs before committing changes.

What is domain language alignment and how does it improve software documentation?

Domain language alignment detects terminology conflicting with current domain vocabulary and pushes for precise canonical terms. It ensures software documentation and glossaries remain consistent with actual codebase behavior.

How do I validate design trade-offs before committing code changes?

Validate design trade-offs by cross-checking stated behavior against the repository to surface contradictions immediately. Resolved terms are recorded in CONTEXT.md, and ADRs are created when decisions are hard to reverse, surprising, and trade-off driven.

When do I need to create an Architecture Decision Record in a software project?

You need to create an Architecture Decision Record when a design decision is hard to reverse, surprising, and trade-off driven. This ensures critical design choices are documented only when they carry significant architectural impact.

How do I resolve ambiguous design decisions using one-question-at-a-time discovery?

Resolve ambiguous design decisions by walking through each design branch with one-question-at-a-time discovery until unresolved parts are clear. This interrogation process updates relevant documentation inline as decisions are finalized.

Does plan interrogation work for software projects with existing documentation and glossaries?

Plan interrogation works effectively for software projects with existing documentation and glossaries by cross-referencing source code and docs. It aligns terminology, validates trade-offs, and updates CONTEXT.md inline during the grilling process.