zoltanmaric/coppersushi / .agents/skills/system-design-diagram
system-design-diagram
VerifiedCreates or revises README system-design diagrams at service and component level, with Mermaid and links to code ownership. Use for architecture overviews or simplifying a diagram that mixes abstraction levels.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.1 KB |
| scripts/architecture_delta.py | script | 2.5 KB |
SKILL.md
View on GitHub---
name: system-design-diagram
description: Creates or revises README system-design diagrams at service and component level, with Mermaid and links to code ownership. Use for architecture overviews or simplifying a diagram that mixes abstraction levels.
---
# System design diagram
Establish the product boundary and revision to describe. Read its owning architecture
document and implementation; for a PR stack, inspect the cumulative implementation
at the requested tip.
Trace the main user journeys and background data paths. Draw the clients, services,
external systems and stores needed to explain them. Keep build-time preparation,
scheduled production and request-time serving distinguishable.
Choose boxes by responsibility and meaningful interfaces. Collapse internal files,
models, validation steps, caches and rendering effects into their owning component
unless their separation changes how the system works. Retain a store, queue or
cache when it explains a persistence, delivery or asynchronous boundary. Do not
invent distributed services to make the picture look like a system-design interview.
Put the whole-system overview in the root README. Label boxes with their role,
technology and runtime/host. Group by provider or server when it simplifies the
view. Label arrows with the request, data or trigger they carry.
Use brief text below the diagram for the few behaviors the picture cannot convey.
Give each owned component a folder README when its internal architecture needs
explaining. Expand only that component, preserving the parent diagram's interfaces.
Link parent and child READMEs in both directions and link collaborating components.
Make diagram nodes clickable with absolute GitHub links to component READMEs on
the default branch (GitHub renders Mermaid in an iframe); provide a
normal Markdown ownership list as a fallback and verify links in the rendered view.
Keep each architectural fact in its owning README; link to the wiki for domain
knowledge and decisions instead of copying them. Do not create empty component
pages or a diagram for every utility folder.
Update the affected parent and component diagrams in the implementation PR that
changes their boundaries or data paths. Describe that revision's implemented
system. Keep proposed dataflows in their spec until implemented.
Use the Mermaid skill for GitHub Markdown. Render the first working slice early,
then inspect it at README width. Shorten labels, combine internal steps or change
layout when readers must zoom to follow the main paths. Check arrows against the
implementation.
Generate the PR's Architecture delta section from committed README diagrams with
`python .agents/skills/system-design-diagram/scripts/architecture_delta.py --base <pr-base> --head <pr-head>`.
Use the PR's immediate base branch for a stack. Review the generated before/after
Mermaid blocks and replace the existing section, preserving the rest of the PR body.
The script reads Git only and prints Markdown; it does not publish or edit files.
Explain code architecture changes separately if the diagrams do not capture them;
unchanged diagrams alone do not prove there was no architecture change.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |