Skip to content
Back to skills

Architecture Doc

ASecurity

Write a concise architecture overview of components, data flow, and key decisions

  • 3 stars
  • 0 votes
  • 0 copies
  • 4 views
  • Added September 3, 2026
ai-agentsgoapi

Works with

  • api

Security analysis

A100/100

Scanned September 3, 2026

npx -y skills add black141312/ada --skill architecture-doc --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Architecture Doc?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Architecture Doc
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/black141312-architecture-doc/badge)](https://www.skillsdirectory.com/skills/black141312-architecture-doc)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: architecture-doc
description: Write a concise architecture overview of components, data flow, and key decisions
category: docs
---

# Architecture Doc

Use this when a new contributor (or future you) needs the mental model of how the system fits together, without reading every file. Aim for a short ARCHITECTURE.md, not a spec.

1. Map the major components/modules and what each is responsible for — read entry points and directory layout first.
2. Trace the primary data/request flow end to end (input → processing → storage → output).
3. Draw one diagram (ASCII or Mermaid) showing components and the arrows between them.
4. Document the key technical decisions and constraints (datastore choice, sync vs async, boundaries) and the why.
5. Note external dependencies and integration points (APIs, queues, third-party services).
6. Add a "where things live" map so readers can jump from a concept to the directory/file.
7. Keep it to a couple of screens; link to deeper docs/ADRs instead of expanding inline.

## Rules
- Explain the why behind structure, not just the what — that's the part code can't show.
- One clear diagram beats three; prefer Mermaid so it renders in-repo.
- Describe boundaries and data flow, not implementation line-by-line.
- Call out the non-obvious: surprising couplings, intentional duplication, hot paths.
- Date it lightly and link related ADRs so it stays anchored as the system evolves.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…