Skillshub common-architecture-diagramming

Standards for creating clear, effective, and formalized software architecture diagrams (C4, UML). (triggers: ARCHITECTURE.md, **/*.mermaid, **/*.drawio, diagram, architecture, c4, system design, mermaid)

install
source · Clone the upstream repo
git clone https://github.com/ComeOnOliver/skillshub
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/ComeOnOliver/skillshub "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/HoangNguyen0403/agent-skills-standard/common-architecture-diagramming" ~/.claude/skills/comeonoliver-skillshub-common-architecture-diagramming && rm -rf "$T"
manifest: skills/HoangNguyen0403/agent-skills-standard/common-architecture-diagramming/SKILL.md
source content

Architecture Diagramming Standard

Priority: P1 (Standard)

Guidelines

  • Use C4 Model: Context->Container->Component->Code.
  • Audience-Centric: Tailor abstraction (Execs vs. Devs).
  • Select Type: Sequence (Protocol), ERD (Data), State (Lifecycle), Cloud (Infra). See Selection
  • Explicit Labels: Label every arrow (e.g., "Uses", "HTTPS").
  • Consistent Notation: Cylinders=DB, Rectangles=Systems, Dashed=Async.
  • Metadata: Title, Date, Version, Author.
  • Legend Mandatory: Define all shapes/colors/styles.
  • Direction:
    graph LR
    (Flow) or
    graph TD
    (Hierarchy).
  • Deployment: Map containers to infrastructure.
  • Governance: CRITICAL: Review best-practices.md before starting.

Anti-Patterns

  • Mixed Levels: DB columns in System Context.
  • Unlabeled Arrows: Ambiguous relations.
  • Mystery Shapes: Undefined in Legend.
  • Dead Ends: Unconnected nodes.
  • Clutter: >20 nodes/diagram.
  • Acronyms: Undefined abbreviations.

References