describe-design
Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Research a codebase and create architectural documentation describing how features or systems work. Use when the user asks to: (1) Document how a feature works, (2) Create an architecture overview, (3) Explain code structure for onboarding or knowledge transfer, (4) Research and describe a system's design. Produces markdown documents with Mermaid diagrams and stable code references suitable for humans and AI agents.
How to use
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.