Writing Design Docs
riekeltStructures proposals, RFCs, specifications and migration plans with explicit choices, costs, evidence and review-ready completeness checks.
By author · 7 skills
Every skill by riekelt in the directory. Each page has a summary, the install command and a link to the source.
Structures proposals, RFCs, specifications and migration plans with explicit choices, costs, evidence and review-ready completeness checks.
Structures operational procedures in the technical-writer plugin with ordered, tested steps, risk labels, rollback instructions and troubleshooting.
Writes honest changelog entries, release notes and shipped-work summaries with consistent structure and user-facing impact.
Creates blameless postmortems in the technical-writer workflow, covering evidence, impact, causes, wrong turns and owned actions.
Records accepted technical decisions as append-only ADRs or lightweight decision-log entries, preserving rationale, alternatives, consequences and supersession.
Guides process documentation with source-controlled diagrams, choosing ArchiMate, PlantUML activity, state, sequence or concept views to show behaviour clearly.
Documents HTTP APIs, messages, webhooks and file formats in technical-writer, separating wire shapes, semantics, examples and errors.