Compétences software-architecture

🏗️

software-architecture

Name: software-architecture
Author: Chemiseblanc

Sûr ⚙️ Commandes externes🌐 Accès réseau

Créer une documentation d'architecture logicielle

Également disponible depuis: Doyajin174

Les projets logiciels manquent souvent de documentation d'architecture claire. Cette compétence fournit des modèles et des patrons pour documenter la conception système, les relations entre composants et les flux de données à l'aide de diagrammes Mermaid.

Prend en charge: Claude Codex Code(CC)

📊 71 Adéquat

Télécharger le ZIP du skill

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

Activez et commencez à utiliser

Tester

Utilisation de "software-architecture". Analyse ce projet d'API REST et crée la documentation d'architecture

Résultat attendu:

ARCHITECTURE.md créé avec vue d'ensemble du système
Diagramme C4 Contexte montrant les utilisateurs, l'API, la base de données et les services externes
Tableau des points d'entrée documentant main.py, api/routes/ et core/
Tableau des abstractions clés avec les classes Handler, Service, Repository
Structure du dossier docs/ avec modèles de documents détaillés des composants

Utilisation de "software-architecture". Crée la documentation pour un nouveau service d'authentification

Résultat attendu:

docs/auth.md avec diagramme C4 Composant
Tableau des fichiers clés avec fichiers handler, service et repository
Diagramme de séquence montrant le flux de connexion avec validation
Tableau des dépendances liant à la base de données et au fournisseur OAuth externe
Section de test avec les emplacements des tests unitaires et d'intégration

Audit de sécurité

Sûr

v5 • 1/16/2026

Pure documentation skill containing only markdown templates and guidance. All 178 static findings are false positives: markdown backticks were misidentified as Ruby shell execution, template placeholders as weak crypto, file path references as reconnaissance, and SHA-256 hashes as C2 keywords. No executable code, network calls, or external commands exist.

Fichiers analysés

811

Lignes analysées

résultats

Total des audits

Facteurs de risque

⚙️ Commandes externes (99)

🌐 Accès réseau (1)

skill-report.json:6

Audité par: claude Voir l’historique des audits →

Score de qualité

Architecture

100

Maintenabilité

Contenu

Communauté

100

Sécurité

Conformité aux spécifications

Ce que vous pouvez construire

Documenter l'architecture d'un système existant

Cartographier les bases de code existantes vers une documentation d'architecture claire pour l'intégration et le transfert de connaissances

Établir des normes de documentation d'architecture

Créer des modèles et des patrons pour assurer la cohérence de la documentation d'architecture à l'échelle de l'équipe

Maintenir une documentation vivante

Mettre à jour la documentation d'architecture pendant les refontes et changements structurels

Essayez ces prompts

Analyser la base de code

Analyse la structure de cette base de code. Identifie les points d'entrée, les composants majeurs et les abstractions clés. Crée ARCHITECTURE.md avec diagramme C4 Contexte, tableau des points d'entrée et liens vers les documents détaillés des composants.

Ajouter une documentation de composant

Crée docs/new-component.md pour le nouveau service. Inclus le diagramme C4 Composant, le tableau des fichiers clés et le diagramme de séquence du flux de données montrant comment il interagit avec les autres composants.

Mettre à jour l'architecture

Examine les changements dans cette PR. Mets à jour ARCHITECTURE.md pour refléter les nouvelles relations entre composants, actualise les diagrammes affectés et vérifie que les références de fichiers dans le tableau des points d'entrée sont exactes.

Créer un flux de données

Documente le flux de données pour le pipeline de traitement. Utilise un organigramme Mermaid montrant les étapes, transformations et chemins de gestion d'erreurs. Inclus le diagramme de séquence pour les interactions clés.

Bonnes pratiques

Garder les diagrammes simples avec 3-5 nœuds initialement, ajouter des détails uniquement lorsque cela améliore la clarté
Utiliser des chemins de fichiers et conventions de nommage cohérents dans toute la documentation
Mettre à jour la documentation d'architecture immédiatement après les changements structurels ou refontes

Éviter

Créer des diagrammes trop complexes avec trop de nœuds et relations
Inclure des détails d'implémentation dans les diagrammes C4 Contexte de haut niveau
Ne pas lier les documents détaillés des composants depuis le ARCHITECTURE.md principal

Foire aux questions

Quels outils IA prennent en charge cette compétence ?

Fonctionne avec Claude, Codex et Claude Code. Tous les outils peuvent lire et écrire des fichiers markdown avec diagrammes Mermaid.

Quels types de diagrammes cette compétence prend-elle en charge ?

Patrons C4 Contexte, C4 Conteneur, C4 Composant, Organigramme, Séquence, Diagramme ER et Diagramme de Classes.

Cette compétence génère-t-elle des diagrammes à partir du code ?

Non. Cette compétence fournit des modèles et des patrons. Les utilisateurs doivent créer les diagrammes en fonction de leur compréhension de la base de code.

Mes données de code sont-elles sécurisées lors de l'utilisation de cette compétence ?

Oui. Cette compétence lit uniquement les fichiers que vous spécifiez et écrit des fichiers de documentation. Aucune donnée n'est envoyée à l'extérieur.

Comment cette compétence s'intègre-t-elle avec la documentation existante ?

La compétence crée ARCHITECTURE.md à la racine du projet et des fichiers optionnels docs/*.md. Les deux sont au format markdown standard.

En quoi est-ce différent des outils d'analyse de code ?

Cette compétence fournit des modèles de documentation et des conseils. Elle n'analyse pas la structure du code ni ne génère automatiquement des diagrammes à partir d'une analyse.

Détails du développeur

Auteur

Chemiseblanc

Licence

MIT

Dépôt

https://github.com/Chemiseblanc/ai/tree/main/skill/software-architecture

Réf

main

Structure de fichiers

📁 references/

📄 document-templates.md

📄 mermaid-patterns.md

📄 SKILL.md