Stats
Actions
Tags
From principled-docs
Create a new architecture document describing current design. Use when documenting a component, data flow, or system design that onboarding engineers need to understand.
How this skill is triggered — by the user, by Claude, or both
Slash command
/principled-docs:new-architecture-docThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
Create a new architecture document describing current system design.
Create a new architecture document describing current system design.
/new-architecture-doc <title> [--module <path>] [--root]
| 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/) |
Parse arguments. Extract the title and determine the target:
--root: target is docs/architecture/ at repo root--module <path>: target is <path>/docs/architecture/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.md and create <target>/<title>.md.
Populate frontmatter:
| Field | Value |
|---|---|
title | The document title (humanized from the slug) |
last_updated | Today's date |
related_adrs | List 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.
templates/architecture.md — Architecture document template (copy of scaffold/templates/core/architecture.md)npx claudepluginhub alexnodeland/principled --plugin principled-docsAudits existing docs and generates full project documentation in docs/ including architecture.md, getting-started.md, development.md, API refs, and ADRs. For onboarding and context sharing.
Generates architecture documents using markdown templates with C4 diagram integration (context, container, component). Creates viewpoint docs, technical overviews, and executive summaries for stakeholders.
Creates new Architecture Decision Records (ADRs) for architectural changes using repo conventions for naming, numbering, and storage. Use when documenting decisions, rationale, and trade-offs.