Documenting Contracts skill: what it does and how to install it
Documents HTTP APIs, messages, webhooks and file formats in technical-writer, separating wire shapes, semantics, examples and errors.
Summary generated from the skill's documentation.
Install
$ npx skills add riekelt/technical-writer --skill documenting-contractsRun it in a terminal. If your agent is already running, start a new session so it picks the skill up.
About this skill
What it does. Documents HTTP APIs, queues, webhooks, commands and file formats through index, semantics, shape and example levels. It builds a DTO-first catalogue with wire types, source anchors, required fields, null and omission behaviour, constraints and shared error entries, while deferring field tables to generated OpenAPI or AsyncAPI specs.
When to use it. Use for contracts consumed by machines, including legacy campaign API references. Do not use for internal code interfaces or configuration references, and do not judge whether the contract is well designed.
History
Repo stars
33
Tracking since . A chart appears once there are 7 days of data.
Stars are counted for the whole repository, which holds 7 skills.
Installs
17.8k
Tracking since . A chart appears once there are 7 days of data.
Installs via skills.sh
Similar skills
- Writing ShapeShapes raw material from a markdown file into an article through chosen openings, grounded concepts and paragraph-by-paragraph drafting.
- Writing RunbooksStructures operational procedures in the technical-writer plugin with ordered, tested steps, risk labels, rollback instructions and troubleshooting.
- Writing PostmortemsCreates blameless postmortems in the technical-writer workflow, covering evidence, impact, causes, wrong turns and owned actions.