tomevault-io Documentation Architecture
Overview
Use this skill to produce architecture documents that improve shared understanding and reduce design/review ambiguity.
Scope Boundaries
- Use this skill when the task matches the trigger condition described in
description. - Do not use this skill when the primary task falls outside this skill's domain.
Shared References
- Review checklist:
references/architecture-doc-review-checklist.md
Templates And Assets
- Architecture document template:
assets/architecture-doc-template.md
- Risk register template:
assets/architecture-risk-register-template.csv
Inputs To Gather
- System boundary and component inventory.
- Dependency relationships and data/control flows.
- Key constraints (security, reliability, compliance, cost).
- Existing ADRs and known architecture risks.
Deliverables
- Architecture narrative and structural views.
- Boundary and dependency explanations.
- Constraint and tradeoff summary.
- Open risks/assumptions and follow-up items.
Quick Structure Template
- Context and goals.
- System boundaries and major components.
- Interaction/data flow and trust boundaries.
- Operational constraints and failure behavior.
- Known risks and decision links.
Quality Standard
- Audience can answer "what talks to what" and "why" quickly.
- Boundaries and ownership are explicit.
- Constraints and tradeoffs are concrete.
- Document links to decisions and unresolved risks.
Workflow
- Identify target audience and key questions.
- Build boundary/dependency narrative and diagrams using
assets/architecture-doc-template.md. - Capture constraints and tradeoffs, and track open risks in
assets/architecture-risk-register-template.csv. - Validate against current implementation and decisions with
references/architecture-doc-review-checklist.md. - Publish with ownership and update cadence.
Failure Conditions
- Stop when architecture boundaries remain ambiguous.
- Stop when documentation omits critical operational constraints.
- Escalate when docs conflict with accepted architecture decisions.
Source: planifest/planifest-framework — distributed by TomeVault.