Home / docs
Docs
Six skills for writing documentation that stays accurate: README author, ADR writer, changelog keeper, onboarding doc, API docs extracted from docstrings and JSDoc, and a postmortem writer.
Install
In Claude Code, add the marketplace and install the plugin:
/plugin marketplace add basitalisandhu/claude-skills
/plugin install docs@claude-skills
Or copy the skill files into ~/.claude/skills/ from a clone:
git clone https://github.com/basitalisandhu/claude-skills
cd claude-skills
python3 install.py --user --only docs
Skills
| Skill | What it does | Scripts |
|---|---|---|
| adr-writer | Write an Architecture Decision Record for a technical choice, with context, the options considered and their trade-offs, the decision and its consequences, in a fixed format with a status lifecycle (proposed, accepted, superseded), numbered and stored in the repository. | no |
| api-docs-from-code | Generate an API reference from source: a bundled script extracts Python docstrings and JavaScript or TypeScript JSDoc into Markdown or JSON, lists public functions and classes with no docstring and gives a documentation coverage number; then fill the gaps and wire it into the docs build. | yes |
| changelog-keeper | Maintain CHANGELOG.md in the Keep a Changelog format with a bundled script that validates the structure, adds entries under Unreleased in the right category, cuts a release (version, date, compare links) and prints a version's section. | yes |
| onboarding-doc | Write a developer onboarding doc that takes a new developer from a clean laptop to their first merged change: setup verified step by step, how the code is organised, how to run, test, deploy and ship the project, the configuration it needs, who owns what, and first tasks. | no |
| postmortem-writer | Write a blameless incident postmortem from the timeline, logs, chat transcript and metrics: impact with numbers, a minute-by-minute timeline, contributing causes found with a structured analysis rather than a single root cause, what went well and what did not, and action items with owners, deadlines and a check that they would have prevented or shortened the incident. | no |
| readme-author | Write or rewrite a README that answers what the project is, who it is for, how to install and use it in under five minutes, and where everything else lives, using a fixed section order and a quality checklist (first screen, copy-pasteable commands verified to work, no stale claims). | no |
Plugin README
Six skills for writing documentation that stays accurate: a README author, an ADR writer, a changelog keeper, an onboarding document, API docs extracted from docstrings and JSDoc, and a postmortem writer.
Find this when you search for: incident report, technical writing.
Install
/plugin marketplace add basitalisandhu/claude-dev-skills
/plugin install docs@claude-dev-skills
Skills then appear as /docs:<skill>. Scripts need Python 3.11 or newer on PATH as python3; they use the standard library only and make no network calls.
Skills
| Skill | Triggers on | Produces |
|---|---|---|
readme-author | no README, stale README, publishing | README in a fixed order with verified commands |
adr-writer | choosing a technology, "why did we do this?" | numbered decision record with options and consequences |
changelog-keeper | changelog line, cut a release, format drift | changelog.py check, add, release, show |
onboarding-doc | new team member, service changes hands | docs/ONBOARDING.md verified on a clean machine |
api-docs-from-code | document this package, stale reference | extract_docs.py Markdown reference and coverage gate |
postmortem-writer | after an outage or near-miss | blameless postmortem with timeline, causes and actions |
Tests for every script live in the repository's tests/ directory; run python3 -m pytest -q at the repository root.