wiki-page-writer
Twórz techniczne dokumentacje z diagramami, cytowaniem kodu i głęboką analizą
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do generowania bogatych stron dokumentacji technicznej z diagramami Mermaid w trybie ciemnym, cytowaniami kodu źródłowego i wyjaśnieniami od podstaw. Aktywuj ją, gdy dokumentujesz konkretny komponent, system lub funkcję, potrzebujesz głębokich analiz technicznych, lub uzupełniasz katalog wiki. Narzędzie wymaga dostępu do repozytorium źródłowego i śledzi rzeczywiste ścieżki kodu zamiast zgadywać na podstawie nazw plików.
Jak używać
Przygotuj kontekst repozytorium — uruchom
git remote get-url origin, aby sprawdzić, czy masz zdalne repozytorium (GitHub, Azure DevOps). Jeśli tak, podaj URL; jeśli pracujesz lokalnie, powiedz o tym umiejętności.Określ gałąź domyślną — uruchom
git rev-parse --abbrev-ref HEAD, aby umiejętność mogła generować prawidłowe linki do kodu.Zdefiniuj zakres dokumentacji — powiedz umiejętności, jaki komponent, system lub funkcję chcesz udokumentować. Określ, czy potrzebujesz diagramów, analizy przepływu danych, czy wyjaśnień algorytmów.
Umiejętność przeanalizuje pliki źródłowe — czyta rzeczywisty kod, identyfikuje wzorce i zależności, nie zgaduje na podstawie nazw plików.
Otrzymasz stronę dokumentacji w Markdown — zawiera strukturyzowane wyjaśnienia, diagramy Mermaid, cytowania kodu z linkami do repozytorium (lub ścieżkami lokalnymi) oraz uzasadnienia projektowe (dlaczego coś istnieje, a nie tylko co robi).
Przejrzyj i dostosuj — jeśli brakuje szczegółów lub chcesz pogłębić konkretny obszar, poproś umiejętność o rozszerzenie sekcji z dodatkowymi dowodami z kodu.