c4-component
Przekształć kod w architekturę — definiuj komponenty, interfejsy i relacje na poziomie C4
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Specjalista do dokumentacji na poziomie komponentów C4. Syntetyzuje dokumentację kodu w logiczną architekturę komponentów, określając granice, interfejsy i zależności między nimi. Generuje diagramy komponentów i dokumentację techniczną. Użyj tej umiejętności, gdy potrzebujesz przejść od dokumentacji kodu do widoku architektonicznego komponentów.
Jak używać
Przygotuj dokumentację kodu, którą chcesz przekształcić w widok komponentów C4. Zbierz informacje o funkcjach, modułach i ich wzajemnych zależnościach na poziomie kodu.
Wyjaśnij cel analizy — określ, które komponenty chcesz wyodrębnić, jakie są ograniczenia projektowe i jakie dane wejściowe masz dostępne (np. struktura repozytorium, dokumentacja API, diagramy przepływu).
Zastosuj najlepsze praktyki C4 dla poziomu komponentów — zdefiniuj granice każdego komponentu, opisz jego typ (aplikacja, serwis, biblioteka), technologie oraz cel biznesowy, który spełnia.
Zdokumentuj interfejsy komponentów, wskazując protokoły komunikacji (REST, GraphQL, gRPC, eventy), operacje dostępne oraz parametry i typy zwracane.
Mapuj zależności — wymień komponenty wewnętrzne, które są używane, oraz systemy zewnętrzne, z którymi komponenty się integrują.
Wygeneruj diagram Mermaid C4Component, który wizualizuje wszystkie komponenty w ramach kontenera, ich interfejsy i relacje — użyj składni C4Component do poprawnego renderowania.