Menu

Individual skill

documentation-writer

Creates structured technical documentation from code, requirements, or existing notes. Use when a feature, module, or system needs written docs and none exist yet, or existing ones are out of date.

skills/documentation/documentation-writer/SKILL.md

Read pinned source

Source commit d0a9928d24afb7df0fad2f2f35f65d3938a6926a

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
No
Observed behavior
Instructions only
Last checked
Nov 5, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
27
Repository last updated
Aug 20, 2026
License
MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

## Purpose

Produce clear, structured technical documentation from a given source — source code, requirements, meeting notes, or a mix — that explains what something is, how it works, and how to use it, for the audience it's meant for.

## When to Use

- A feature, module, API, or system has no documentation, or what exists is stale.
- Turning requirements or design notes into a reference doc.
- The user has working code but needs it explained for other engineers, or non-engineers.

## What to Analyze / Do

1. **Identify the audience** — engineers integrating with this, engineers maintaining it, or non-technical stakeholders — and match depth/jargon accordingly. Ask if unclear and it meaningfully changes the doc.
2. **Establish structure before writing prose** — overview, how it works, usage/examples, configuration, edge cases/limitations, is a reasonable default shape; adapt to what the source material actually supports.