c4-container
Dokumentuj architekturę wdrożeniową na poziomie kontenerów C4 z precyzją
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do tworzenia dokumentacji architektonicznej na poziomie kontenerów C4. Pomaga syntetyzować dokumentację komponentów w architekturę wdrożeniową, mapować komponenty na jednostki wdrażania, dokumentować interfejsy kontenerów jako API i generować diagramy. Idealny dla zespołów projektujących systemy rozproszone i definiujących strukturę wdrożeń.
Jak używać
Przygotuj dokumentację komponentów, które chcesz zsyntezować na poziom kontenerów. Zbierz informacje o każdym komponencie, jego przeznaczeniu i zależnościach.
Zdefiniuj cele i ograniczenia swojej architektury wdrożeniowej — określ, jakie kontenery potrzebujesz, jakie technologie będą używane (np. Docker, Kubernetes) i jak będą się komunikować.
Użyj skilla, aby zmapować komponenty na jednostki wdrażania (kontenery). Dla każdego kontenera określ jego nazwę, typ (aplikacja webowa, API, baza danych itp.), technologie i strategię wdrażania.
Udokumentuj interfejsy każdego kontenera jako API — zdefiniuj protokoły komunikacji (REST, GraphQL, gRPC), opisy endpointów i specyfikacje. Powiąż interfejsy z dokumentacją komponentów.
Zidentyfikuj zależności między kontenerami i systemami zewnętrznymi. Opisz, jak kontenery się komunikują i jakie protokoły są używane.
Jeśli potrzebujesz szczegółowych przykładów implementacji, otwórz plik resources/implementation-playbook.md w repozytorium skilla. Zweryfikuj swoją architekturę, sprawdzając, czy wszystkie komponenty są poprawnie zmapowane i czy interfejsy są kompletne.