adr

Documentation

Index

• type ADR
  • func (adr *ADR) BuildDocument(parsedTemplate *render.ParsedTemplateFile) (*io_document.IODocument, error)
  • func (adr *ADR) SequencedTitle() string

Types

type ADR

type ADR struct {
	Sequence     int
	Title        string
	Context      string
	Decision     string
	Status       string
	Consequences string
}

ADR represents an Architectural Decision Record (ADR). It stores details about decisions made during software architecture design.

func (*ADR) BuildDocument

func (adr *ADR) BuildDocument(parsedTemplate *render.ParsedTemplateFile) (*io_document.IODocument, error)

BuildDocument creates an IODocument from the ADR using the provided template. It renders the ADR content into the template and returns a document that can be written to disk. Returns an error if rendering fails or if the template is invalid.

func (*ADR) SequencedTitle

func (adr *ADR) SequencedTitle() string

SequencedTitle returns the ADR's title prefixed with its sequence number. This is used for display purposes to distinguish between different ADRs.