Agent skill · software engineering · aiskillstore
software-architecture
Document software architecture using ARCHITECTURE.md and docs/*.md files with Mermaid diagrams. Use proactively when ARCHITECTURE.md exists in project root, or invoke to create initial architecture documentation. Covers system design, data flows, component relationships, and code organization with references to key entry points and abstractions.
Why this skill is useful
Provides a structured approach to documenting software architecture with specific templates and diagram types that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Software Architecture Documentation Document system architecture using a root ARCHITECTURE.md with detailed component docs in docs/.md. Structure Proactive Usage When ARCHITECTURE.md exists in project root: 1. Before major changes: Read ARCHITECTURE.md to understand system structure 2. After structural changes: Update diagrams and entry points 3. When adding components: Create new docs/.md file and link from ARCHITECTURE.md 4. During refactoring: Update affected diagrams and file references Creating Architecture Documentation Initial Setup Workflow 1. Analyze codebase structure Identify entry points (main, CLI, API handlers) Map major components and their responsibilities Trace key data flows 2. Create ARCHITECTURE.md Write system overview (1-2 paragraphs) Add C4 Context diagram showing system boundaries Document entry points table List key abstractions Add testing overview Link to detail docs (create docs/ section even if empty initially) 3. Create detail docs for major components One file per logical component in docs/ Name files to match component names (flexible convention) Include component-level diagrams See references/document-templates.md for complete templates. ARCHITECTURE.md Sections Required Sections Section Content --------- --------- Overview 1-2 paragraphs on system purpose System Diagram C4 Context or Container diagram Key Entry Points Table of primary files with descriptions Key Abstractions Table of important classes/interfaces/functions Testing Overview of test strategy and key test locations Detail Docs Links to docs/.md files Optional Sections Section Include When --------- -------------- Data Flow Complex pipelines or transformations Code Organization Non-obvious directory structure Configuration Significant config or environment setup Detail Documents (docs/.md) Create a detail doc when a component: Has 3+ key files or abstractions Contains complex internal logic Interacts with multiple other components Needs sequence diagrams to explain flows …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/software-architecture