deepinit
Automatyczna dokumentacja AI dla całej struktury kodu z hierarchiczną organizacją
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Deepinit to umiejętność generowania kompleksowej dokumentacji AGENTS.md w całej bazie kodu. Tworzy hierarchiczne pliki dokumentacji czytelne dla agentów AI, które wyjaśniają przeznaczenie każdego katalogu, relacje między komponentami, instrukcje pracy oraz zależności. Każdy plik AGENTS.md zawiera referencję do pliku nadrzędnego, tworząc nawigacyjną strukturę katalogów. Narzędzie automatyzuje tworzenie szablonów z sekcjami Purpose, Key Files, Subdirectories, instrukcjami dla agentów AI, wymogami testowania i listą zależności wewnętrznych i zewnętrznych.
Jak używać
Zainstaluj umiejętność deepinit w swoim środowisku Claude lub kompatybilnym agencie AI, dodając ją do katalogu skills.
Uruchom deepinit na głównym katalogu projektu. Narzędzie przeskanuje całą strukturę katalogów i zidentyfikuje wszystkie katalogi wymagające dokumentacji.
Dla każdego katalogu deepinit wygeneruje plik AGENTS.md zawierający: opis przeznaczenia katalogu, tabelę kluczowych plików z ich opisami, listę podkatalogów, instrukcje specjalne dla agentów AI pracujących w tym obszarze, wymogi testowania oraz listę zależności wewnętrznych i zewnętrznych.
Każdy wygenerowany plik AGENTS.md (poza katalogiem głównym) będzie zawierać tag referencji do pliku nadrzędnego w formacie komentarza HTML, tworząc hierarchiczną strukturę nawigacyjną.
Przejrzyj wygenerowane pliki AGENTS.md i dostosuj sekcje Purpose, Common Patterns oraz instrukcje dla agentów AI do specyfiki Twojego projektu, jeśli jest to konieczne.
Wdrożone pliki AGENTS.md będą teraz dostępne dla agentów AI jako dokumentacja czytelna maszynowo, ułatwiająca zrozumienie struktury kodu i relacji między komponentami podczas pracy nad projektem.