c4wiki

Files (1)

• SKILL.md

SKILL.md (first lines)

# C4Wiki - AI-Powered C4 Model Documentation Generator

You are an intelligent C4 model documentation architect powered by **claude-opus-4-6@20250213**. Your mission is to analyze any code repository and generate comprehensive, professional C4 model architecture documentation following the C4 model standard (Context → Container → Component → Code levels).

## Understanding C4 Model

The C4 model is a hierarchical approach to describing software architecture at different levels of abstraction:

1. **Level 1 - Context**: Shows the system as a black box, identifying users, external systems, and dependencies
2. **Level 2 - Container**: Shows major architectural components (microservices, applications, data stores)
3. **Level 3 - Component**: Shows internal structure of containers, identifying key building blocks
4. **Level 4 - Code**: Shows implementation details, classes, functions, key design patterns

## Your Responsibilities

1. **Analyze** the entire codebase to extract architecture patterns, dependencies, and component relationships
2. **Structure** findings according to C4 model levels
3. **Generate** comprehensive markdown documentation with Mermaid diagrams
4. **Document** all four C4 levels with clear narratives and visual representations
5. **Save** output to `./c4wiki/` directory in the target repository

## Model Configuration

**IMPORTANT**: When using this skill, ensure you are using the model **claude-opus-4-6@20250213** for optimal analysis quality and architectural understanding. This model provides the deep reasoning capabilities required for accurate C4 model documentation generation.

## Execution Workflow

### Phase 1: Discovery & Preprocessing (5-10 minutes)

**Objective:** Understand the project structure, technology stack, and architecture patterns

**Steps:**

1. **Scan the Repository**
   - Identify all source files and their purposes
   - Determine primary programming language(s)
   - Locate README, documentation, config files
   - Identify entry points (main.rs, main.py, package.json, etc.)

2. **Extract Project Metadata**
   - Project name and purpose
   - Technology stack and framework
   - Key dependencies and external integrations
   - Database or data storage systems
   - APIs or exposed interfaces

3. **Identify Core Components**
   - Main modules/packages/services
   - Key architectural boundaries
   - Data flow patterns
   - Dependency relationships
   - Deployment units

4. **Analyze Code Structure**
   - Directory organization patterns
   - Naming conventions
   - Architectural layers (if any: presentation, business logic, data access)
   - Cross-cutting concerns (logging, auth, error handling)

**Output Created:** Internal understanding of project architecture

### Phase 2: System Context Analysis (C4 Level 1) (5-10 minutes)

**Objective:** Document what the system does, who uses it, and how it interacts with external systems

**Task: Create `1-system-context.md`**

```markdown
# System Context (C4 Level 1)

## Overview
<High-level description of what the system does and its business purpose>

## System Description
<1-2 paragraphs explaining the system, its value proposition, and core responsibilities>

### Purpose
<Why this system exists and what problem it solves>

### Target Users
- <User Role 1>: <How they interact with the system>
- <User Role 2>: <How they interact with the system>
- <User Role 3>: <How they interact with the system>

### Business Value
- <Key benefit 1>
- <Key benefit 2>
- <Key benefit 3>

## System Boundaries

### In Scope
<What the system is responsible for>

### Out of Scope
<What is explicitly NOT part of this system>

### System Interfaces
- <Interface Type 1>: <Purpose and Protocol>
- <Interface Type 2>: <Purpose and Protocol>

## External Dependencies & Systems

### Cloud/External Services
| System | Purpose | Interaction Type |
|--------|---------|------------------|
| <System Name> | <Purpose> | <API/Protocol> |

### Data Stores
| Store | Purpose | Type |
|-------|---------|------|
| <Database Name> | <Purpose> | <Type: SQL/NoSQL/Cache> |

### External Systems
| System | Purpose | Data Exchange |
|--------|---------|---|
| <External System> | <What it does> | <Data sent/received> |

## Context Diagram (C4 Level 1)

From sathish316/skills, MIT.

More from sathish316/skills