writing-adr

Included with Lifetime

$97 forever

Write an Architecture Decision Record (ADR) — lead with the decision, give neutral context, and state consequences both ways. Use when recording an architectural or technical decision, documenting why a choice was made, or capturing tradeoffs for future maintainers.

Writing & Docs

What this skill does


# ADR Writing

An ADR captures a decision and the forces behind it, so a future maintainer doesn't
have to reverse-engineer "why is it like this?" from the code. It is a log entry, not
a monument. (For proposing a change still under debate, use `writing-rfc`.)

## The rules that govern everything

**Lead with the decision.** State it in the first lines, in active voice ("We will…").
Context and justification follow. Don't bury the conclusion under the analysis.

**State consequences both ways.** What becomes easier *and* what becomes harder, what
you now owe. The honesty of the "harder" half is what makes the record trustworthy.

**Append-only.** A record is not edited away when it's overturned. Set the old ADR's
status to `Superseded by ADR-NNN` and link forward; preserve the original reasoning.

## Skeleton

1. **Title** — `ADR-NNN: <the decision, as a short imperative>`.
2. **Status** — Proposed / Accepted / Superseded by ADR-NNN · date.
3. **Context** — the forces at play: requirements, constraints, what's true today.
   Concrete and neutral. No solution yet — just the situation that demands one.
4. **Decision** — one or two sentences, active voice: "We will…".
5. **Consequences** — what becomes easier, what becomes harder, what we now owe. Both
   directions. This is where the honesty lives.

Optionally add **Alternatives considered** (each with an honest why-not) when the
rejected options carry real weight, and **Non-goals** to bound scope.

## Filling it well

- Keep Context free of the answer — describe the problem so neutrally that a reader
  could reach a different decision from the same facts.
- Quantify the forces: the throughput need, the cost, the on-call burden — not just
  "performance mattered."
- The Decision is a hammer: short, declarative, unambiguous.
- In Consequences, name the thing you now owe (the new dependency, the manual step,
  the migration) before someone discovers it the hard way.
- Link to the implementation, related ADRs, and any RFC that led here.

## Checklist

- [ ] Decision stated in the first lines, active voice.
- [ ] Status and date present; supersession linked if applicable.
- [ ] Context is concrete, neutral, and solution-free.
- [ ] Consequences cover both easier and harder.
- [ ] Forces quantified where possible.
- [ ] Alternatives noted if they carry weight, each with a why-not.
- [ ] Links to implementation and related records.

Files: 1

Size: 2.7 KB

Complexity: 7/100

Category: Writing & Docs

Source: https://github.com/mgomes/3xo-suit/tree/main/plugins/dotfiles/skills/writing-adr

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts