docs-architect
Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
How to use
Przygotuj dostęp do repozytorium kodu, który chcesz zdokumentować. Skill będzie analizować strukturę folderów, zależności między modułami i wzorce implementacyjne.
Wyjaśnij cele dokumentacji — czy potrzebujesz przewodnika architektonicznego, podręcznika dla nowych deweloperów, czy e-booka z deep-dive'em technicznym. Określ docelową publiczność i poziom szczegółowości.
Skill przeanalizuje codebase w fazie odkrywania: zidentyfikuje kluczowe komponenty, ich relacje, przepływy danych i punkty integracji. Wyodrębni decyzje architektoniczne i zastosowane wzorce projektowe.
W fazie strukturyzacji skill zaproponuje hierarchię rozdziałów i sekcji, planując progresywne ujawnianie złożoności. Zasugeruje diagramy, schematy i materiały wizualne niezbędne do zrozumienia systemu.
Skill wygeneruje dokumentację w fazie pisania, zaczynając od streszczenia wykonawczego i przeglądu ogólnego, następnie przechodząc do szczegółowych wyjaśnień. Zapewni spójną terminologię i jasne wyjaśnienia dla różnych poziomów zaawansowania czytelnika.
Zweryfikuj wygenerowaną dokumentację pod kątem dokładności i kompletności. Jeśli potrzebujesz szczegółowych przykładów implementacyjnych, skill może odwołać się do playbooka w
resources/implementation-playbook.md.