New Architecture Doc — Architecture Document Creation
Create a new architecture document describing current system design.
Command
/new-architecture-doc <title> [--module <path>] [--root]
Arguments
| Argument | Required | Description |
|---|---|---|
<title> |
Yes | Descriptive title for the architecture document (e.g., data-flow, authentication-system) |
--module <path> |
No | Target module path |
--root |
No | Create at repo root level (docs/architecture/) |
Workflow
Parse arguments. Extract the title and determine the target:
- If
--root: target isdocs/architecture/at repo root - If
--module <path>: target is<path>/docs/architecture/ - Otherwise: determine from current working context
- If
Scan for related ADRs. Look in the corresponding
docs/decisions/directory for ADRs that may be related to this architecture document. List them for cross-referencing.Create the document. Read
templates/architecture.mdand create<target>/<title>.md.Populate frontmatter:
Field Value titleThe document title (humanized from the slug) last_updatedToday's date related_adrsList of related ADR numbers found in step 2 Pre-populate ADR references. In the "Key Decisions" section, insert links to the related ADRs discovered in step 2.
Confirm creation. Report the file path and remind the user that architecture docs are living documents — they should be updated as the design evolves and should always reference the ADRs that produced the current design.
Architecture Doc Conventions
- Architecture docs use freeform descriptive names (no number prefix).
- They are living documents — updated as design evolves.
- They reference ADRs that produced the current design.
- Their primary audience is onboarding engineers.
Templates
templates/architecture.md— Architecture document template (copy ofscaffold/templates/core/architecture.md)
Converted and distributed by TomeVault — claim your Tome and manage your conversions.