c4-architecture-c4-architecture
Generuj dokumentację architektury C4 z analizy kodu od dołu do góry
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umożliwia automatyczne tworzenie pełnej dokumentacji architektury C4 dla istniejących repozytoriów. Narzędzie analizuje kod od najgłębszych katalogów w górę, tworząc dokumentację na czterech poziomach: Code, Component, Container i Context. Każdy element kodu jest dokumentowany przed syntezą w wyższe abstrakcje, co zapewnia spójność i kompletność dokumentacji dla zespołów technicznych i biznesowych.
Jak używać
Przygotuj repozytorium kodu, które chcesz udokumentować. Upewnij się, że masz dostęp do wszystkich katalogów i plików źródłowych, które mają być analizowane.
Zainicjuj workflow C4 Architecture Documentation Workflow, podając cel dokumentacji, ograniczenia projektowe oraz wymagane dane wejściowe (np. strukturę repozytorium, główne moduły, technologie użyte).
Workflow automatycznie uruchamia czterech specjalistycznych agentów C4 pracujących sekwencyjnie. Zacznij od poziomu Code: agent analizuje każdy podkatalog od dołu do góry, tworząc dokumentację na poziomie kodu dla każdego elementu.
Agent Component syntetyzuje dokumentację kodu w logiczne komponenty w ramach kontenerów. Następnie agent Container mapuje komponenty na kontenery wdrażające z dokumentacją API i zależnościami.
Agent Context tworzy diagram kontekstu pokazujący system w relacji do użytkowników i systemów zewnętrznych. Zweryfikuj wygenerowaną dokumentację pod kątem kompletności i dokładności.
Jeśli potrzebujesz szczegółowych przykładów implementacji, zapoznaj się z plikiem resources/implementation-playbook.md. Dokumentacja jest gotowa do udostępnienia interesariuszom technicznym i biznesowym.