describe-design
Automatycznie dokumentuj architekturę kodu z diagramami i referencjami
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do badania bazy kodu i tworzenia dokumentacji architektonicznej. Generuje markdown z diagramami Mermaid, opisując jak działają funkcje i systemy. Idealny do onboardingu, transferu wiedzy i wyjaśniania struktury kodu dla zespołów i agentów AI. Dokumentacja jest czytelna zarówno dla ludzi, jak i dla sztucznej inteligencji.
Jak używać
Określ zakres badań — powiedz skillowi, którą funkcję, system lub komponent chcesz udokumentować. Wyjaśnij, czy dokumentacja ma być dla deweloperów, agentów AI, czy obu grup.
Potwierdź lokalizację bazy kodu, jeśli nie wynika ona z kontekstu rozmowy. Skill przeskanuje strukturę katalogów, pliki README i konfiguracyjne, aby zbudować wstępny model organizacji projektu.
Przejrzyj proponowany zarys dokumentacji — skill przedstawi listę komponentów do zbadania. Potwierdź, że poprawnie zrozumiał zakres, lub wyjaśnij, co należy zmienić.
Czekaj na głębokie badanie — skill przeanalizuje ścieżki kodu, zależności między komponentami, opcje konfiguracji i przepływy danych. Dla każdego komponentu zbierze informacje o wejściach, wyjściach i interakcjach.
Otrzymaj gotową dokumentację w formacie markdown z diagramami Mermaid i stabilnymi referencjami do kodu. Dokument będzie zawierać przegląd architektury, szczegóły komponentów i instrukcje dla przyszłych czytelników.