Document Runtime Architecture Flows is a development Claude Skill built by Pieter Kuppens. Best for: Software architects and senior engineers document critical execution paths, component interactions, and runtime behavior to clarify system design and aid debugging..
- What it does
- Document technical execution paths, component interactions, and runtime sequences using arc42 §6 standards with sequence diagrams.
- Category
- development
- Created by
- Pieter Kuppens
- Last updated
Document Runtime Architecture Flows
Document technical execution paths, component interactions, and runtime sequences using arc42 §6 standards with sequence diagrams.
Skill instructions
name: architecture-runtime description: Documents runtime behaviour: technical execution paths, component interactions, sequences (arc42 §6). Use when documenting flows or tracing execution.
Architecture Runtime
Documents technical execution paths through components and services. Aligns with arc42 §6 (runtime view). Contrast with user flows (UX journey) — see design-consult for user flow documentation.
When to use
- Documenting critical execution paths
- When new features add significant flows
- Debugging complex interactions
Outputs
docs/architecture/03-runtime-flows.md— append/update scenariodocs/architecture/diagrams/sequences.mmd— sequence diagram
Flow scenario format
For each scenario in 03-runtime-flows.md:
- Trigger — what initiates; entry point; preconditions
- Step-by-step — technical sequence (HTTP → Controller → Service → DB)
- Components involved — links to component docs
- Data touched — tables, cache, external APIs
- Error handling — what can fail; retries; fallbacks
- Observability — logs, metrics, traces
Selection criteria
Prioritise: MVP smoke test path; most frequently executed; business-critical; complex (multi-component); error-prone.
Sequence diagram
Use Mermaid sequenceDiagram with participants, messages, returns, error paths.
Update rules
- Document actual code paths; cite evidence
- Link to component docs
- Show success and error paths
Integration
- Parent: architecture.
- Complements architecture-building-blocks for component details.
Install
/plugin install document-runtime-architecture-flows@pkuppensRequires Claude Code CLI.
Use cases
Software architects and senior engineers document critical execution paths, component interactions, and runtime behavior to clarify system design and aid debugging.
Reviews
No reviews yet. Be the first to review this skill.