author-tech-debt-plan

Creates structured tech-debt plan documents grounded in actual code exploration.

Updated May 2, 2024
One-click install
npx skills add https://github.com/cman131/EatSomethingSourWhenYoureTired --skill author-tech-debt-plan-cman131
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: author-tech-debt-plan
Source: https://github.com/cman131/EatSomethingSourWhenYoureTired/tree/main/.claude/skills/author-tech-debt-plan
Command: npx skills add https://github.com/cman131/EatSomethingSourWhenYoureTired --skill author-tech-debt-plan-cman131

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing tech-debt documentation often produces vague, assumption-based write-ups that engineers cannot act on. This Skill guides the creation of tech-debt plan documents for the mahjong-site project that cite real files, line numbers, and code snippets, conforming to the format expected by the execute-tech-debt-plan workflow. ## Core Features & Use Cases - Code-grounded discovery: Uses Grep, Glob, and Read to locate affected files and line numbers before writing, so every Problem Details entry cites actual evidence. - Structured template: Fills a fixed template with Title, State, Summary, Problem Details, Impact, Suggested Fix, and Related Files sections. - Area classification: Routes the document into the correct docs/tech-debt/ subdirectory (auth, games, tournaments, users, ranked-league, resources, ui, or a new folder). - Use Case: You notice a race condition in game verification. Describe it in one sentence, and the Skill explores the relevant code, drafts a complete plan document, and writes it to docs/tech-debt/games/game-verification-race-condition.md. ## Quick Start Ask the assistant to write a tech-debt plan for a specific bug or UX gap, providing a one-sentence description of the problem.

Frequently Asked Questions about author-tech-debt-plan

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

FAQPage Schema
How do I write a tech-debt plan document for a codebase?▼

Provide a one-sentence description of the debt, bug, or UX gap. The Skill explores the affected code with Grep, Glob, and Read, drafts a structured document with problem details and a suggested fix, and writes it to the appropriate docs/tech-debt/ subdirectory.

What sections should a tech-debt document include?▼

The template includes Title, State, Summary, Problem Details, Impact, Suggested Fix, and Related Files. Every Problem Details entry must cite an actual file path and line number with a code snippet where useful.

How are tech-debt documents organized by area?▼

Documents are filed under docs/tech-debt/ subdirectories: auth, games, tournaments, users, ranked-league, resources, and ui. If none fits, you can specify a new folder name when prompted.

Why does the Skill read code before writing the plan?▼

Reading the actual code prevents assumption-based write-ups. Every claim in Problem Details needs a real file path and line number, so the document is actionable for whoever implements the fix.

What happens after a tech-debt plan is created?▼

The Skill reports the created file path and suggests running the execute-tech-debt-plan command on that file to implement the fix described in the document.