ArchDoc Design record
ArchDoc

Glossary

Terms used across this project's design record, exported from the repository.

B

backfilled

#backfilled

An RFC or ADR created directly in a terminal status to record a decision taken before it was written. Its front matter carries a backfilled date alongside the historical created and decided dates, and it requires a Sources section.

E

editable

#editable

A document that is not frozen: any spec page, any ref, and any RFC or ADR whose status on the configured branch is not terminal.

effectively obsolete

#effectively-obsolete

An RFC or ADR that an accepted document obsoletes. Obsolescence claimed by a document in any other status has no effect.

F

frozen

#frozen

An RFC or ADR that exists on the configured branch with a terminal status. Lint reports any change to it and every writer refuses one.

I

identifier

#identifier

The name a numbered document is referred to by: the uppercased type, a hyphen and a four-digit number, derived from the filename.

implemented

#implemented

An accepted RFC or ADR that some spec page includes.

P

page

#page

A spec page, identified by its path below spec/ without the extension.

R

root

#root

The directory under which the document directories, README.md, PROCESS.md and INDEX.md live. Named in archdoc.json relative to that file, and at or below it.

S

slug

#slug

The part of a numbered document's filename after the number, derived from the title at creation and never changed by the tool.

stale

#stale

A spec page that includes a document that is effectively obsolete.

T

terminal

#terminal

One of the statuses accepted, rejected or withdrawn. A document with a terminal status has no outgoing transition.