TWISTEdBRACKETS

Skill

Refining Docs

Refine and tune an existing technical doc set: gap analysis, consistency, diagrams, decision tuning.

// workflow;

Behaviour

What it does

  • Runs gap analysis on undefined decisions and missing sections
  • Cross-checks docs for stack, entity, endpoint, and terminology consistency
  • Adds or updates Mermaid diagrams with captions
  • Tunes decision ownership tags and propagates consequences
  • Appends REQ-level changes to docs/technical/CHANGELOG.md
  • Never silently changes human-locked decisions
  • Reports findings before editing so you can steer the changes

When to use

Good fits

When you update requirements or technical docs on an existing app

After decisions change and before impact analysis

When docs have drifted from the codebase or each other

Before planning a brownfield delta, to close open decisions

Development harness

Design support

Part of the design-to-ship pipeline: brainstorming → technical-documentation → conformance-check → reconciling-changes → planning → project-setup → executing-plans → shipping. Install the full set for structured feature work.

Runs alongside the design phase after technical-documentation to keep docs/technical/ accurate.

Install

Get this skill

Uses Agent Kit via npx; no global install required.

Quick install

sh
npx @levi-putna/agent-kit@latest add levi-putna/skills --skill refining-docs

Global (Cursor)

sh
npx @levi-putna/agent-kit@latest add levi-putna/skills --skill refining-docs --global --agent cursor

Global (Claude)

sh
npx @levi-putna/agent-kit@latest add levi-putna/skills --skill refining-docs --global --agent claude

Project install

sh
npx @levi-putna/agent-kit@latest add levi-putna/skills --skill refining-docs --project

Interactive install

sh
npx @levi-putna/agent-kit@latest add levi-putna/skills

Uninstall

sh
npx @levi-putna/agent-kit@latest remove refining-docs

Example

Example prompt

Refining Docs

Review docs/technical/ for gaps and inconsistencies before we plan the build.

Flow

How the skill works

  1. Load the target docs and any cross-referenced files
  2. Diagnose gaps, inconsistencies, or unclear decisions
  3. Report findings and get agreement before editing
  4. Apply focused changes in place and update CHANGELOG.md
  5. Hand off to conformance-check when behaviour changed