plan-authoring

Generates plan.md and auxiliary technical artifacts for spec-driven development units.

Updated Jan 28, 2024
One-click install
npx skills add https://github.com/Thiago-Cruz-eng/KrockSide --skill plan-authoring-thiago-cruz-eng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plan-authoring
Source: https://github.com/Thiago-Cruz-eng/KrockSide/tree/main/.agents/skills/plan-authoring
Command: npx skills add https://github.com/Thiago-Cruz-eng/KrockSide --skill plan-authoring-thiago-cruz-eng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing the technical plan for a work unit often produces inconsistent documents: technology choices without a confirmed basis, business rules leaking into technical sections, and optional artifacts generated or skipped at random. This Skill standardizes how plan.md and its auxiliary files (data-model.md, research.md, contracts/, ui/) are authored in a spec-driven development workflow. ## Core Features & Use Cases - Structured plan.md authoring: Defines the expected sections (stack, technical decisions, data model, contracts, interface, testing strategy, documentation impact) and what belongs in each. - Decision provenance enforcement: Requires every settled technology choice to cite a concrete confirmation basis (code in use, user statement, AGENTS.md) recorded in research.md, escalating unconfirmed choices as gaps. - Explicit optional-artifact decisions: Forces a recorded generate-or-waive verdict for each canonical optional (data-model.md, research.md, contracts/, ui/) with a one-line reason. - Use Case: When planning a new backend module, use this Skill to produce a plan.md that traces from the current code state, documents tradeoffs in research.md, specifies the REST API in contracts/*.openapi.yaml, and records deliberate documentation drift. ## Quick Start Ask the AI to author the plan.md and supporting technical artifacts for the current spec unit following the plan-authoring standard.

Frequently Asked Questions about plan-authoring

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

FAQPage Schema
How do I write a plan.md in spec-driven development?

Start from the current code state, then fill the expected sections: stack and structure, technical decisions, data model, external contracts, interface, testing strategy, and documentation impact. Move large content into auxiliary files like data-model.md or research.md and link them from plan.md.

What goes in research.md versus plan.md?

research.md holds the detail of each non-trivial decision: context, alternatives, decision, rationale, confirmation basis, and consequences. plan.md keeps only an overview of technical decisions and cites research.md for tradeoffs and provenance.

When can a technology choice be treated as settled in a plan?

A technology is settled only with a concrete basis: already used in the code, or stated without reservation by the user or source artifacts like AGENTS.md or discovery-answers.md. Anything carrying a reservation becomes a gap escalated to the human, not a decision.

Which optional artifacts should a spec unit include?

Evaluate each canonical optional explicitly: data-model.md, research.md, contracts/, and ui/. Generate one only if it avoids ambiguity in executing tasks, and record the generate-or-waive verdict with a one-line reason in plan.md.

When does a plan require a documentation update task?

Only when there is deliberate drift: the unit intentionally changes behavior and a recorded decision backs it. Divergences between documentation and code without a resolving decision are open gaps escalated to the human, not doc tasks.