dbreunigdbreunigCommunity·1 Agent Skills Included

scaffold-docs-skill

Iterative technical documentation writing with human review checkpoints

Writes complete technical documentation for code libraries through a structured, top-down workflow. Builds Getting Started tutorials, Diving Deeper topic guides, and API reference sections in reviewable passes instead of one-shot drafts. Eliminates stale docs by diffing code changes since the last sync and proposing targeted updates. Applies audience-first structure and Strunk & White prose standards so docs teach real mental models, not just API lists.
npx skills add dbreunig/scaffold-docs-skill --all -g -y

All Skills in This Repository (1)

Pure Emerald Level Indicators

Frequently Asked Questions

FAQPage Schema
How to install scaffold-docs?

Run `npx skills add dbreunig/scaffold-docs-skill --all -g -y` in your terminal to install the skill globally.

How to write documentation for a code library?

Invoke the skill and it reads your codebase, defines a target audience, then builds Getting Started, Diving Deeper, and Reference sections in passes you approve at each step.

How to keep docs in sync with code changes?

Ask the skill to update the docs. It diffs the code since the last recorded commit, classifies the changes, and proposes edits section by section for your review.

Does scaffold-docs work with Claude Code?

Yes. It follows the standard SKILL.md format and runs in Claude Code and other compatible coding environments.

Do I need writing experience to use scaffold-docs?

No. The skill applies built-in prose and headline style rules, and you stay in control by reviewing and approving each pass before it continues.

Related Repositories in Content & Communication

View All in Content & Communication