c4-component
Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level documentation into Component-level architecture, defining component boundaries, interfaces, and relationships. Creates component diagrams and documentation. Use when synthesizing code-level
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level documentation into Component-level architecture, defining component boundaries, interfaces, and relationships. Creates component diagrams and documentation. Use when synthesizing code-level documentation into logical components.
How to use
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.