Help us shape the future of Go! Take the 2026 Go Developer Survey

adr

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package adr is the architecture-decision-record format (SPEC-ADDITIONS §12): the durable, routable home for a team's local trade-off decisions — Status, Context, Decision, and Consequences split into Easier and Harder. It is both the skeleton a promoted `decision` lesson renders and the structural proof a decision- resolution arc closes with. Both Render and Valid are pure.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Render

func Render(title, contextBody string) string

Render returns an ADR skeleton (§12): Status / Context / Decision / Consequences split into Easier and Harder. contextBody is the forcing context the caller supplies; the Decision and its trade-offs are left as placeholders a human completes before the ADR is a valid proof. It is pure.

func Valid

func Valid(text string) error

Valid reports whether text is a complete ADR: it carries a Status and the Context, Decision, and Consequences (Easier + Harder) sections, and no skeleton placeholder remains (§12). It is the structural proof a `decision`-resolution arc closes with — an unfilled skeleton is rejected so an undelivered decision cannot ship. It returns EINVALID naming the first defect.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL