architecture-documentation

# Architecture Documentation

## When to Use This Skill

Use this skill when you need to:

- Generate architecture documentation for a system
- Create C4 diagrams (Context, Container, Component)
- Document architecture for different stakeholder viewpoints
- Produce technical overviews or executive summaries

**Keywords:** document, c4, container, context, component, viewpoint, architecture description, technical overview, executive summary

## Document Types

| Type | Audience | Content |
| --- | --- | --- |
| Context | All stakeholders | System boundaries, external interactions |
| Container | Technical leads | Services, databases, major components |
| Component | Developers | Internal structure of containers |
| Deployment | Operations | Infrastructure, environments |
| Data | Data architects | Data flows, storage, schemas |
| Executive Summary | Leadership | Business value, key decisions |

## Document Generation Workflow

### 1. Analyze the Codebase

Before generating documentation:

1. Identify the scope (single service, multiple services, entire system)
2. Find existing documentation to incorporate
3. Locate key architectural files (configs, deployment specs)

### 2. Select Document Type

Choose based on:

- **Audience**: Who will read this?
- **Purpose**: Decision support, onboarding, compliance?
- **Scope**: Component, service, or system level?

### 3. Generate Documentation

Each document type has a standard structure:

#### Context Document

```markdown
# System Context: [System Name]

## Overview
[1-2 paragraph description]

## Context Diagram
[C4 Context diagram - via visualization plugin]

## External Systems
| System | Description | Integration |
| --- | --- | --- |
| ... | ... | ... |

## Users/Actors
| Actor | Description | Interactions |
| --- | --- | --- |
| ... | ... | ... |
```

#### Container Document

```markdown
# Container Architecture: [System Name]

## Overview
[Architecture summary]

## Container Diagram
[C4 Container diagram - via visuali