CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

writing-adrs

Use when authoring an Architecture Decision Record (ADR) — a short document that captures one significant, hard-to-reverse technical or architectural decision, its context, and its consequences. Triggered by the sdlc ADR pipeline (the knowledge-engineer agent behind /sdlc:docs seed adr and /sdlc:docs distill) when generating an ADR from a story, and by anyone hand-authoring an ADR under docs/adr/ today. Covers why ADRs are kept short and inverted-pyramid, the required sections (Title, Status, Decision, Context, Alternatives Considered, Consequences), the proposed→accepted→superseded (or →rejected) status lifecycle and the never-edit-only-supersede immutability rule, the NNNN-decision-slug.md filename convention, and the ADR frontmatter fields (status, agents, source-stories) the pipeline reads to route a generated ADR into docs/adr/index.md.

Quality

87%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

75%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

Highly actionable content with concrete templates, a worked example, and a validation checklist, but at ~290 lines it runs long — several rationale-heavy passages could be tightened or split out without losing clarity. The one structural weakness is the buried, non-linked external reference in the Template section.

Suggestions

Tighten the rationale-dense passages (the immutability paragraph, the docs/adr/index.md regeneration passage, and the inline justification clauses in Required Sections) — state the rule plus one crisp reason instead of layered rationales.

Convert the bare "plugins/sdlc/refs/artifact-encoding.md" path on line 147 into a clearly signaled reference (or drop it if the file is not part of this bundle), since it is currently buried mid-paragraph and unverifiable.

Consider moving the ~65-line worked example ADR to a references/ file with a well-signaled pointer, keeping the required-sections spec and template inline in SKILL.md.

DimensionReasoningScore

Conciseness

The body is ~290 lines with layered rationales and parenthetical asides throughout — e.g. the immutability paragraph's justification, the 12-line index-regeneration passage, and clauses like "long documents go unread and go stale" inside the Decision section. Most content is opinionated guidance rather than padding, but several passages clearly could be tightened, fitting anchor 3 better than anchor 4.

3 / 5

Actionability

Fully concrete: copy-paste-ready YAML frontmatter, a complete markdown template, a fully worked example ADR, an exact filename convention with example ("0001-htmx-for-active-web-pages.md"), and the concrete "highest existing number + 1" rule. It matches anchor 5's copy-paste-ready, common-cases-covered bar.

5 / 5

Workflow Clarity

The supersede flow is precisely sequenced with timing ("Only at the moment the new ADR is itself accepted do the two records flip together") and the "Self-Review Checklist (run before saving)" is an explicit validation checkpoint. However, the overall authoring process (pick number → copy template → fill sections → run checklist) is never laid out as an ordered sequence, keeping it at anchor 4 rather than 5.

4 / 5

Progressive Disclosure

Sections are well organized and clearly headed, and there are no nested references. Minor gaps: the ~65-line worked example and the niche pipeline-routing/regeneration detail could live in separate reference files, and line 147 points to "plugins/sdlc/refs/artifact-encoding.md" as a bare path outside the bundle rather than a proper link. This fits anchor 4's "minor organization gaps".

4 / 5

Total

16

/

20

Passed

Description

92%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: it explicitly answers what and when, uses third person, and enumerates concrete capabilities with specific trigger sources. Its only weakness is modest — a few natural phrasings a user might say ("decision log", "write an ADR") are absent, and the length pushes against the verbosity guideline.

DimensionReasoningScore

Specificity

The description enumerates concrete capabilities: "captures one significant, hard-to-reverse technical or architectural decision", "the required sections (Title, Status, Decision, Context, Alternatives Considered, Consequences)", "the NNNN-decision-slug.md filename convention", and "the ADR frontmatter fields (status, agents, source-stories)" — comprehensive coverage of what the skill governs.

5 / 5

Completeness

Both questions are explicitly answered: "Use when authoring an Architecture Decision Record…" states when, with concrete trigger phrases ("Triggered by the sdlc ADR pipeline… and by anyone hand-authoring an ADR under docs/adr/ today"), and the enumerated coverage list states what. It clearly matches anchor 5.

5 / 5

Trigger Term Quality

Good natural-term coverage: "ADR", "Architecture Decision Record", "authoring an ADR", "docs/adr/", plus the pipeline commands. A few natural phrasings users might say are missing (e.g. "decision log", "documenting a decision", "write an ADR"), which fits anchor 4 rather than the comprehensive synonym coverage of anchor 5.

4 / 5

Distinctiveness Conflict Risk

ADR authoring is a clear niche with distinct triggers (ADR, Architecture Decision Record, the sdlc pipeline commands, docs/adr/) and minimal overlap with adjacent documentation skills, matching anchor 5.

5 / 5

Total

19

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

whimzyLive/nightshift-ai

Path

plugins/sdlc/skills/writing-adrs/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.