Toolverse
All skills

c4-code

by sickn33

Expert C4 Code-level documentation specialist. Analyzes code directories to create comprehensive C4 code-level documentation including function signatures, arguments, dependencies, and code structure. Use when documenting code at the lowest C4 level for individual directories

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
sickn33
Category
Backend

About this skill

Expert C4 Code-level documentation specialist. Analyzes code directories to create comprehensive C4 code-level documentation including function signatures, arguments, dependencies, and code structure. Use when documenting code at the lowest C4 level for individual directories and code modules.

How to use

  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.

Related skills