riekelt/technical-writer

1427

technical-writing Use when writing, restructuring, or revising any technical document - specs, design docs, READMEs, reference document…

riekelt/technical-writer

15.7K

1466

writing-design-docs Use when writing a proposal, RFC, design document, spec, or migration plan - anything that argues for a change, recor…

riekelt/technical-writer

15.3K

1467

reviewing-technical-prose Use when reviewing, rewriting, or editing someone else's technical text, when writing a review report on a document, …

riekelt/technical-writer

15.3K

1473

writing-runbooks Use when writing operational documentation - runbooks, setup guides, release procedures, migration guides, deprecatio…

riekelt/technical-writer

15.2K

1476

writing-changelogs Use when writing a changelog entry, release notes, or a "what shipped" summary after completing work. Encodes the ent…

riekelt/technical-writer

15.1K

1481

writing-postmortems Use when writing a postmortem, incident report, or root-cause analysis after an outage, a defect that reached users, …

riekelt/technical-writer

15.1K

1486

recording-decisions Use when a decision needs recording - an ADR, a decision log entry, or when someone asks to write down why something …

riekelt/technical-writer

15.1K

1485

writing-issues Use when writing or refining tracker items - epics, stories, tasks, bug reports, spikes, or acceptance criteria - or …

riekelt/technical-writer

15.1K

1501

documenting-legacy-codebases Use when documenting an existing codebase whose documentation is missing, stale, or untrusted - an inherited system, …

riekelt/technical-writer

15K

1511

diagramming-processes Use when a business process, workflow, lifecycle, or interaction between systems needs a diagram - a flow that prose …

riekelt/technical-writer

14.9K

1516

documenting-contracts Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks - or when writin…

riekelt/technical-writer

14.8K