skills.rest
asengardeon
asengardeonCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

sdd-docs

Generates and updates technical documentation including READMEs, docs, and ADRs via the tech-writer agent.

Updated Aug 25, 2026
Search Tags:#documentation#technical writing#adr#claude code#readme#sdd#tech-writer
One-click install
npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill sdd-docs-asengardeon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sdd-docs
Source: https://github.com/asengardeon/btt-sdd-pipeline/tree/main/.claude/skills/sdd-docs
Command: npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill sdd-docs-asengardeon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping technical documentation accurate and current is a recurring chore in spec-driven development. This Skill provides an on-demand utility in the SDD pipeline that delegates documentation writing and updates to a dedicated tech-writer agent, so READMEs, docs/ files, and ADRs stay in sync with what actually exists in the codebase. ## Core Features & Use Cases - Scoped documentation tasks: Write or update a specific file such as README.md, a document under docs/, or a new ADR, based on the user's request. - Full documentation inventory: Document all pipeline mechanics when the user asks to "document everything". - Code-to-example preservation: Transform real production code into a documented example before the code is removed from the repository, specifying where the example should live. - Use Case: Before deleting a legacy module, ask the Skill to turn it into a documented example in docs/ so its illustrative value survives the removal. ## Quick Start Ask the assistant to update the README and create an ADR documenting the latest architectural decision using the sdd-docs skill.

Frequently Asked Questions about sdd-docs

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

FAQPage Schema
How do I generate or update project documentation automatically?▼

Invoke the sdd-docs skill with a scope such as a specific file (README.md, a docs/ page, or a new ADR) or a request to document everything. It delegates the work to the tech-writer agent and reports what was documented and where.

How do I preserve code as a documented example before deleting it?▼

Tell the skill that the code will be removed from the repository and where the documented example should live. The tech-writer agent transforms the real code into a documented example at the specified location before removal.

Does sdd-docs require completing other SDD pipeline stages first?▼

No. It is a free utility in the SDD pipeline with no fixed numbered stage and no prerequisite artifact. It can be invoked at any time documentation needs to be written or updated.

What happens if the tech-writer agent is not available?▼

The skill falls back to following the instructions in .claude/agents/tech-writer.md directly. In that mode it only documents what actually exists and never writes or corrects production code.

Can sdd-docs modify production source 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.

Related Skills

Explore More Software Engineering Skills→
AITOBIAS04AITOBIAS04
3

ride

Analyze a codebase to generate evidence-grounded PRD, SDD, and hygiene reports.

Community
Advanced
zorgentechzorgentech

adr-approve

Move approved ADR files to docs/adr and update status via GitHub CLI.

Official
Advanced
sumithrsumithr
5

sumo-qa-finishing-qa-work

Capture fresh test evidence, coverage snapshots, and risk-to-test mappings into a markdown QA summary.

Community
Advanced
NeoLabHQNeoLabHQ
1.5k

update-docs

Updates project documentation for local code changes using multi-agent tech-writer workflows.

Official
Advanced