wiki-architect

Wiki Architect analizuje repozytoria kodu i tworzy hierarchiczne struktury dokumentacji wraz z przewodnikami onboardingu. Narzędzie mapuje architekturę projektu, identyfikuje warstwy aplikacji (prezentacja, logika biznesowa, dostęp do danych, infrastruktura) i generuje katalogi wiki z przewodnikami dla różnych ról: współtwórców, inżynierów, kierownictwa i product managerów. Idealne do szybkiego zrozumienia struktury dużych projektów i tworzenia dokumentacji od zera.

1. 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).

2. 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.

3. 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ę.

4. 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).

5. 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.

6. Użyj wygenerowanej dokumentacji do szybkiego wdrażania nowych członków zespołu, komunikacji architektury z kierownictwem lub planowania rozwoju projektu.