enhance-docs

Skill do ulepszania dokumentacji poprzez skupienie się na rzeczywistych zadaniach użytkowników. Analizuje zawartość, identyfikuje nieaktualne lub zagmatwane fragmenty, a następnie reorganizuje tekst, aby zmniejszyć poznawczy wysiłek i zwiększyć przejrzystość. Pracuje z mapowaniem celów użytkownika, weryfikacją dokładności względem kodu i API, oraz usuwaniem redundancji na rzecz konkretnych przykładów i instrukcji działania.

1. Przygotuj informacje wejściowe: określ, które pliki lub sekcje dokumentacji chcesz ulepszyć, zidentyfikuj główne grupy użytkowników i ich zadania (co chcą osiągnąć), wskaż źródło prawdy o zachowaniu produktu (kod, API, changelog) oraz wymień ostatnie zmiany lub planowane wydania.

2. Uruchom skill i podaj zakres dokumentacji. Jeśli brakuje któregoś z pięciu wejść (zakres, odbiorcy, źródło prawdy, zmiany, ograniczenia), skill poprosi o uzupełnienie.

3. Skill mapuje 3–5 głównych zadań użytkownika i przypisuje każdemu odpowiednie sekcje dokumentacji, aby upewnić się, że zawartość wspiera rzeczywiste cele.

4. Porównuje dokumentację z aktualnym kodem i API, aby znaleźć nieaktualne informacje, sprzeczności i luki. Wyniki rankuje według wpływu na powodzenie użytkownika.

5. Reorganizuje tekst: usuwa redundancje, skraca długie listy, dodaje jasne nagłówki i strukturę, a także wstawia minimalne przykłady tylko tam, gdzie odblokowują działanie. Priorytetyzuje zmiany o największym wpływie.

6. Odbierz raport z mapą zadań, rankingiem problemów, proponowanymi zmianami i szybkimi wygraniami — wszystko gotowe do wdrożenia w dokumentacji.