Documentation C4 de conteneur

VérifiéSûr

Guide expert pour créer des diagrammes de déploiement et descriptions de composants au niveau conteneur C4.

Spar Skills Guide Bot
DocumentationIntermédiaire
23/07/2026
Claude CodeCursorCodex
#c4-model#architecture-diagrams#mermaid#container-documentation#system-deployment

Recommandé pour

Synthèse automatique

Ce skill fournit des modèles et des bonnes pratiques pour rédiger la documentation C4 au niveau conteneur d'un système, y compris les diagrammes Mermaid C4Container et les spécifications d'API OpenAPI.

Points forts

  • Structure prête à l'emploi par conteneur : nom, type, technologie, déploiement, composants, interfaces, dépendances et infrastructure
  • Modèle de diagramme Mermaid C4Container directement réutilisable avec personnes, conteneurs et systèmes externes
  • Rappelle les principes officiels du modèle C4 : choix technologiques, répartition des responsabilités, protocoles de communication
  • Inclut un squelette de spécification OpenAPI 3.1 pour documenter les API de chaque conteneur

Limites

  • Ce sont des gabarits à remplir : le skill ne génère ni n'analyse automatiquement l'architecture réelle du système
  • Les exemples restent génériques (Spring Boot, Node.js, PostgreSQL) et doivent être adaptés au contexte
  • Aucune validation du rendu Mermaid ni de la cohérence du fichier OpenAPI n'est prévue
Quand l'utiliser

À utiliser lorsqu'il faut documenter l'architecture d'un système au niveau conteneur, avec diagramme C4 et description des interfaces et dépendances de chaque conteneur.

Quand l'éviter

À éviter pour des tâches hors documentation d'architecture C4, comme du codage applicatif, du diagnostic de performance ou des diagrammes de niveau contexte ou composant.

Analyse de sécurité

Sûr
Score qualité80/100

The skill is a documentation template for C4 container diagrams and OpenAPI specs. It declares no tools and contains no destructive, exfiltration, network, or obfuscated instructions.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Document a microservices architecture
Write the C4 container-level documentation for our e-commerce platform: a React web app, three Node.js services, PostgreSQL and RabbitMQ, all deployed on Kubernetes. Include a Mermaid C4Container diagram.
Add a container to existing docs
Add a new container section for our Redis cache to the existing C4 container documentation, following the standard template with interfaces, dependencies and infrastructure.
Draft the API spec for a container
Create an OpenAPI 3.1 specification for the Orders API container's REST endpoints and link it from the container's Interfaces section.

name: c4-container description: Expert C4 Container-level documentation specialist. risk: unknown source: community date_added: '2026-02-27'

C4 Container Level: System Deployment

Use this skill when

  • Working on c4 container level: system deployment tasks or workflows
  • Needing guidance, best practices, or checklists for c4 container level: system deployment

Do not use this skill when

  • The task is unrelated to c4 container level: system deployment
  • You need a different domain or tool outside this scope

Instructions

  • Clarify goals, constraints, and required inputs.
  • Apply relevant best practices and validate outcomes.
  • Provide actionable steps and verification.
  • If detailed examples are required, open resources/implementation-playbook.md.

Containers

[Container Name]

  • Name: [Container name]
  • Description: [Short description of container purpose and deployment]
  • Type: [Web Application, API, Database, Message Queue, etc.]
  • Technology: [Primary technologies: Node.js, Python, PostgreSQL, Redis, etc.]
  • Deployment: [Docker, Kubernetes, Cloud Service, etc.]

Purpose

[Detailed description of what this container does and how it's deployed]

Components

This container deploys the following components:

    • Documentation: c4-component-name.md

Interfaces

[API/Interface Name]

  • Protocol: [REST/GraphQL/gRPC/Events/etc.]
  • Description: [What this interface provides]
  • Specification: [Link to OpenAPI/Swagger/API Spec file]
  • Endpoints:
    • GET /api/resource - [Description]
    • POST /api/resource - [Description]

Dependencies

Containers Used

  • [Container Name]: [How it's used, communication protocol]

External Systems

  • [External System]: [How it's used, integration type]

Infrastructure

  • Deployment Config: [Link to Dockerfile, K8s manifest, etc.]
  • Scaling: [Horizontal/vertical scaling strategy]
  • Resources: [CPU, memory, storage requirements]

Container Diagram

Use proper Mermaid C4Container syntax:

C4Container
    title Container Diagram for [System Name]

    Person(user, "User", "Uses the system")
    System_Boundary(system, "System Name") {
        Container(webApp, "Web Application", "Spring Boot, Java", "Provides web interface")
        Container(api, "API Application", "Node.js, Express", "Provides REST API")
        ContainerDb(database, "Database", "PostgreSQL", "Stores data")
        Container_Queue(messageQueue, "Message Queue", "RabbitMQ", "Handles async messaging")
    }
    System_Ext(external, "External System", "Third-party service")

    Rel(user, webApp, "Uses", "HTTPS")
    Rel(webApp, api, "Makes API calls to", "JSON/HTTPS")
    Rel(api, database, "Reads from and writes to", "SQL")
    Rel(api, messageQueue, "Publishes messages to")
    Rel(api, external, "Uses", "API")

**Key Principles** (from [c4model.com](https://c4model.com/diagrams/container)):

- Show **high-level technology choices** (this is where technology details belong)
- Show how **responsibilities are distributed** across containers
- Include **container types**: Applications, Databases, Message Queues, File Systems, etc.
- Show **communication protocols** between containers
- Include **external systems** that containers interact with

API Specification Template

For each container API, create an OpenAPI/Swagger specification:

openapi: 3.1.0
info:
  title: [Container Name] API
  description: [API description]
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: Production server
paths:
  /api/resource:
    get:
      summary: [Operation summary]
      description: [Operation description]
      parameters:
        - name: param1
          in: query
          schema:
            type: string
      responses:
        '200':
          description: [Response description]
          content:
            application/json:
              schema:
                type: object

Example Interactions

  • "Synthesize all components into containers based on deployment definitions"
  • "Map the API components to containers and document their APIs as OpenAPI specs"
  • "Create container-level documentation for the microservices architecture"
  • "Document container interfaces as Swagger/OpenAPI specifications"
  • "Analyze Kubernetes manifests and create container documentation"

Key Distinctions

  • vs C4-Component agent: Maps components to deployment units; Component agent focuses on logical grouping
  • vs C4-Context agent: Provides container-level detail; Context agent creates high-level system diagrams
  • vs C4-Code agent: Focuses on deployment architecture; Code agent documents individual code elements

Output Examples

When synthesizing containers, provide:

  • Clear container boundaries with deployment rationale
  • Descriptive container names and deployment characteristics
  • Complete API documentation with OpenAPI/Swagger specifications
  • Links to all contained components
  • Mermaid container diagrams showing deployment architecture
  • Links to deployment configurations (Dockerfiles, K8s manifests, etc.)
  • Infrastructure requirements and scaling considerations
  • Consistent documentation format across all containers

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/c4-container-documentation-mrx3xyiu' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/c4-container-documentation-mrx3xyiu/download' --output '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md.part' && mv '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md.part' '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Extrait original : Dependencies

Containers Used

  • [Container Name]: [How it's used, communication protocol]

External Systems

  • [External System]: [How it's used, integration type]

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && test -s '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/c4-container' && cp -R '.skill-downloads/c4-container-documentation-mrx3xyiu' '.claude/skills/c4-container'

Cursor
test -f '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && test -s '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/c4-container' && cp -R '.skill-downloads/c4-container-documentation-mrx3xyiu' '.cursor/skills/c4-container'

Codex
test -f '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && test -s '.skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/c4-container' && cp -R '.skill-downloads/c4-container-documentation-mrx3xyiu' '.agents/skills/c4-container'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/c4-container-documentation-mrx3xyiu'

openskills read 'c4-container-documentation-mrx3xyiu'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/c4-container-documentation-mrx3xyiu/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires