c4-code

Specjalista do tworzenia dokumentacji C4 na najniższym poziomie szczegółowości. Analizuje strukturę katalogów kodu, wyodrębnia sygnatury funkcji, parametry, zależności i organizację modułów. Idealne do dokumentowania poszczególnych komponentów, klas i funkcji w ramach architektonicznego modelu C4. Oszczędza czas na ręcznym opisywaniu struktury kodu i utrzymywaniu dokumentacji na bieżąco.

1. Przygotuj katalog lub moduł kodu, który chcesz udokumentować. Upewnij się, że masz dostęp do ścieżek plików i struktury katalogów, które będą analizowane.

2. Uruchom umiejętność c4-code i określ cel dokumentacji — wskaż konkretny katalog lub moduł, dla którego potrzebujesz dokumentacji C4 na poziomie kodu.

3. Wyjaśnij ograniczenia i wymagane dane wejściowe: podaj język programowania, główne funkcje lub klasy, które powinny być udokumentowane, oraz ewentualne zależności wewnętrzne i zewnętrzne.

4. Umiejętność przeanalizuje strukturę kodu i wygeneruje dokumentację zawierającą sygnatury funkcji z typami parametrów, opisy klas i modułów, mapę zależności oraz relacje między komponentami.

5. Zweryfikuj wygenerowaną dokumentację — sprawdź, czy wszystkie kluczowe funkcje i klasy są uwzględnione, czy ścieżki plików są prawidłowe, i czy zależności są dokładnie zmapowane.

6. W razie potrzeby szczegółowych przykładów implementacji otwórz plik resources/implementation-playbook.md dołączony do umiejętności, aby uzyskać dodatkowe wytyczne i wzorce.