wiki-architect
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.
How to use
Aktywuj umiejętność Wiki Architect, gdy chcesz utworzyć wiki, wygenerować dokumentację lub zmapować strukturę repozytorium. Narzędzie automatycznie wykryje, czy pracujesz z lokalnym repozytorium czy zdalnym (GitHub, Azure DevOps).
Przed analizą kodu narzędzie określi kontekst źródłowego repozytorium — uruchomi polecenie
git remote get-url origin, aby znaleźć zdalny URL. Jeśli repozytorium jest tylko lokalne, wskaż to wprost.Narzędzie zeskanuje strukturę plików, README i zidentyfikuje typ projektu, języki programowania, frameworki oraz wzorce architektoniczne. Wykryje warstwy aplikacji: prezentację, logikę biznesową, dostęp do danych i infrastrukturę.
Na podstawie analizy wygeneruje hierarchiczny katalog wiki z sekcjami: Getting Started (przegląd, setup, użycie), Deep Dive (architektura, podsystemy, komponenty) oraz przewodniki onboardingu dostosowane do roli (Contributor Guide, Staff Engineer Guide, Executive Guide, Product Manager Guide).
Każda sekcja będzie zawierać cytowania rzeczywistych plików z repozytorium — linki do konkretnych linii kodu na GitHub lub ścieżki do plików lokalnych, co ułatwi nawigację i weryfikację dokumentacji.
Użyj wygenerowanej dokumentacji do szybkiego wdrażania nowych członków zespołu, komunikacji architektury z kierownictwem lub planowania rozwoju projektu.