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.

Plugin docs, version 0.1.1, 6 skills, MIT licence. Source: claude-dev-skills. Synced .

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

SkillWhat it doesScripts
adr-writerWrite 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-codeGenerate an API reference from source with a bundled script that extracts Python docstrings (Google, NumPy and reST styles) and JavaScript/TypeScript JSDoc blocks into Markdown or JSON, lists undocumented public symbols, and measures documentation coverage; then fill the gaps and wire the extraction into the docs build.yes
changelog-keeperMaintain 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-docWrite a developer onboarding document for a repository or service that gets a new team member from a clean machine to a merged change: environment setup verified step by step, how the code is organised, how to run and test it, the configuration it needs, the deployment path, who owns what, and the first tasks.no
postmortem-writerWrite 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-authorWrite 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.

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

SkillTriggers onProduces
readme-authorno README, stale README, publishingREADME in a fixed order with verified commands
adr-writerchoosing a technology, "why did we do this?"numbered decision record with options and consequences
changelog-keeperchangelog line, cut a release, format driftchangelog.py check, add, release, show
onboarding-docnew team member, service changes handsdocs/ONBOARDING.md verified on a clean machine
api-docs-from-codedocument this package, stale referenceextract_docs.py Markdown reference and coverage gate
postmortem-writerafter an outage or near-missblameless 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.