docs

Generates and updates technical documentation including READMEs, ADRs, and documented code examples.

Updated Aug 25, 2026
One-click install
npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill docs-asengardeon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/asengardeon/btt-sdd-pipeline/tree/main/plugins/btt-sdd/skills/docs
Command: npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill docs-asengardeon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping technical documentation accurate and current is tedious work that teams often skip. This Skill invokes a dedicated tech-writer agent to write or update READMEs, docs/ files, and ADRs, and to preserve real code as documented examples before it is removed from the repository. ## Core Features & Use Cases - Scoped Documentation: Document a single target file (README.md, a docs/ page, a new ADR) or run a full inventory of the pipeline's mechanics. - Code-to-Example Preservation: Transform real production code into a documented example before deleting it, so its illustrative value survives. - Agent Delegation with Fallback: Invokes the tech-writer subagent when available, or follows the same process directly when the Agent tool is unavailable. - Use Case: Before removing a legacy module from the repository, ask the Skill to turn it into a documented example stored in docs/, preserving the knowledge without keeping dead code. ## Quick Start Ask the assistant to document the current feature's README and create an ADR for the latest architectural decision using the docs skill.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I generate a README for my project automatically?▼

Invoke the docs skill with the target file specified, such as README.md. It delegates the writing to a tech-writer agent that documents only what actually exists in the repository, then summarizes what was created or updated.

How to preserve code as documentation before deleting it?▼

Tell the skill which code will be removed and where the documented example should live. The tech-writer agent transforms the real code into a documented example so its illustrative value survives after deletion.

Can this skill write architecture decision records?▼

Yes, creating a new ADR is one of the supported scopes. Specify the ADR as the target and the tech-writer agent drafts it based on the actual decisions present in the project.

What happens if the Agent tool is not available?▼

The skill falls back to following the tech-writer agent's documented process directly. It still only documents existing code and never writes or modifies production code.

Does the documentation skill modify production code?▼

No, the skill explicitly forbids writing or correcting production code. Its scope is limited to documentation artifacts such as READMEs, docs/ files, ADRs, and documented code examples.