documentation-architecture
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.
More from kentoshimizu/sw-agent-skills
graph-algorithms
Graph algorithm workflow for modeling entities/relations and selecting traversal, path, ordering, or flow strategies. Use when correctness or performance depends on graph representation and algorithm choice; do not use for schema-only modeling or deployment topology planning.
14bash-style-guide
Style, review, and refactoring standards for Bash shell scripting. Trigger when `.sh` files, files with `#!/usr/bin/env bash` or `#!/bin/bash`, or CI workflow blocks with `shell: bash` are created, modified, or reviewed and Bash-specific quality controls (quoting safety, error handling, portability, readability) must be enforced. Do not use for generic POSIX `sh`, PowerShell, or language-specific application style rules. In multi-language pull requests, run together with other applicable `*-style-guide` skills.
11architecture-clean-architecture
Clean Architecture workflow for enforcing dependency direction, stable domain boundaries, and use-case-centered application design. Use when teams must separate business rules from frameworks and delivery mechanisms; do not use for isolated module cleanup without boundary implications.
11powershell-style-guide
Style, review, and refactoring standards for PowerShell scripting. Trigger when `.ps1`, `.psm1`, `.psd1` files, or CI workflow blocks with `shell: pwsh` or `shell: powershell` are created, modified, or reviewed and PowerShell-specific quality controls (error handling, parameter validation, readability, operational safety) must be enforced. Do not use for Bash, generic POSIX `sh`, or language-specific application style rules. In multi-language pull requests, run together with other applicable `*-style-guide` skills.
10github-codeowners-management
Govern CODEOWNERS rules so review routing reflects real ownership and risk boundaries on GitHub. Use when repository ownership mapping or mandatory reviewer rules must be defined, updated, or audited; do not use for non-GitHub runtime architecture or data-layer design.
9security-authentication
Security workflow for authentication architecture, credential lifecycle, and session/token assurance. Use when login, identity proofing, MFA, or session security decisions are required; do not use for authorization policy design or non-security quality tuning.
9