tech-debt

Maintains a schema-validated Markdown table tracking low-stakes code cleanup items in docs/TECH_DEBT.md.

Updated Apr 9, 2014
One-click install
npx skills add https://github.com/thoroc/thoroc.github.io --skill tech-debt-thoroc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tech-debt
Source: https://github.com/thoroc/thoroc.github.io/tree/main/.agents/skills/tech-debt
Command: npx skills add https://github.com/thoroc/thoroc.github.io --skill tech-debt-thoroc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, shellcheck, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Small code-level cleanup items (lint warnings, dead imports, weak tests) get noticed and forgotten because they are too minor for a risk register and not features for a roadmap. This Skill maintains docs/TECH_DEBT.md as a single committed table for exactly those items, with schema validation and clear boundaries against the risk register and roadmap. ## Core Features & Use Cases - Structured row filing: Append cleanup rows with a defined schema (id, item, area, description, effort, since, status) illustrated by a YAML template and enforced by a JSON Schema. - Pre-commit validation: scripts/validate-tech-debt-schema.sh checks every table row against the schema, wired into lefthook pre-commit so malformed rows cannot be committed locally. - Boundary due diligence: Built-in rules for deciding whether an item is cleanup, a real risk (promote to docs/RISK_REGISTER.md), or already tracked by aislop's baseline. - Use Case: You notice an unused import that eslint only warns about. File it as a tech-debt row with the next available number, a self-contained description, and Effort: S, then validate before committing. When fixed, delete the row after confirming no hidden risk was revealed. ## Quick Start Ask the agent to log a small cleanup item you noticed as a new row in docs/TECH_DEBT.md using the tech-debt skill.

Frequently Asked Questions about tech-debt

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

FAQPage Schema
How do I add a tech debt entry to docs/TECH_DEBT.md?▼

Confirm the item is genuinely cleanup rather than a risk, read the last row's number and use it plus one, write a self-contained description, and append the row matching the YAML template. Then run scripts/validate-tech-debt-schema.sh before committing.

What is the difference between tech debt and a risk register entry?▼

Tech debt rows cover low-stakes cleanup with no real cost if left unaddressed, and are deleted once fixed. Risk register entries carry real cost or failure modes, are append-only, and preserve a decision audit trail.

How do I mark a tech debt item as fixed?▼

Delete the row entirely; there is no Resolved status. Before deleting, confirm the fix did not reveal a real risk, and if it did, add a row to docs/RISK_REGISTER.md referencing the tech-debt item first.

When should I not file something as tech debt?▼

Do not file anything with a real cost or risk if ignored, anything already tracked in .aislop/baseline.json, or anything confidential. Those belong in the risk register, the aislop baseline, or nowhere committed respectively.

Why does the pre-commit hook block my tech debt commit?▼

The validate-tech-debt-schema.sh script found a row violating the JSON Schema, such as a bad effort value, malformed date, or a literal pipe character inside a cell. Fix the row to match the schema constraints and re-commit.