Documenting Contracts
by riekelt85e53729dd95No license28 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 3 weeks ago
Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks - or when writing the api-reference of a legacy campaign, or when callers keep asking what a field means or which errors an endpoint returns. Encodes the four detail levels, the DTO-first catalog, wire types with source anchors, the generated-spec one-home rule, and omitted-versus-null semantics. Use whenever a machine interface needs documenting for its callers, even if nobody says "API docs".
- 85e53729dd95Currentcommit 85e5372Published Oct 8, 2026
Source and attribution
Source:riekelt/technical-writerinplugins/technical-writer/skills/documenting-contractsat commit85e5372
License: No license
Content belongs to its original authors. SourceWeft indexes it from a public repository.
More from riekelt/technical-writer
Writing Runbooks
riekelt
Guides writing of runbooks, setup, release, migration and deprecation procedures that someone will execute under time pressure.
Writing Postmortems
riekelt
Guides writing blameless postmortems, incident reports, and root-cause analyses with evidence-based timelines and owned action items.
Writing Issues
riekelt
Guides writing tracker issues such as epics, stories, tasks, bugs and spikes with testable acceptance criteria.
Writing Design Docs
riekelt
Guides writing proposals, RFCs, design docs, specs and migration plans with a fixed skeleton and completeness checks.
Writing Changelogs
riekelt
Guides writing changelog entries, release notes and handover summaries with fixed entry shapes and honesty conventions.
Technical Writing
riekelt
House style and truth rules for drafting, restructuring, and revising technical documents such as specs, design docs, and READMEs.
More in Writing & Content
Doc Coauthoring
anthropics
Guides users through a three-stage workflow to co-author documentation, proposals, specs and decision docs.
Writing Guidelines
vercel-labs
Reviews documentation and prose against fetched Writing Guidelines and reports style findings.
Job Post Builder
anthropics
Builds a hiring packet — job post, interview guide with rubrics, and offer letter template — from a role brief.
Write Spec
anthropics
Turns a feature idea or problem statement into a structured PRD with goals, user stories, requirements and metrics.
Draft Content
anthropics
Drafts marketing content such as blog posts, social posts, newsletters, landing pages, press releases and case studies.
Brand Voice Enforcement
anthropics
Applies existing brand voice guidelines to sales and marketing content, then explains the brand choices made.