documentation-templates

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

1. Zainstaluj skill w swoim projekcie, korzystając z dostarczonego repozytorium. Skill wykorzystuje narzędzia Read, Glob i Grep do pracy z plikami dokumentacji.

2. Dla nowego projektu zacznij od szablonu README. Wypełnij obowiązkowe sekcje w kolejności: tytuł z jednolinijkowym opisem, Quick Start (uruchomienie w poniżej 5 minut), Features, Configuration, linki do dokumentacji API i Contributing.

3. Dokumentuj każdy endpoint API, używając szablonu per-endpoint. Dla każdego endpointu określ metodę HTTP i ścieżkę, dodaj parametry w tabeli (nazwa, typ, wymagalność, opis), wymień możliwe kody odpowiedzi (np. 200, 404) i dołącz przykład request-response.

4. W kodzie źródłowym stosuj szablon JSDoc/TSDoc dla funkcji i metod. Każdy blok komentarza powinien zawierać krótki opis, parametry (@param), wartość zwracaną (@returns), wyjątki (@throws) i przykład użycia (@example).

5. Pamiętaj o regule komentowania: opisuj "dlaczego" (logika biznesowa), a nie "co" (oczywiste rzeczy). Komentuj złożone algorytmy i nieoczywiste zachowania, ale unikaj komentowania każdej linii czy oczywistego kodu.

6. Przechowuj szczegółową dokumentację w osobnych plikach (np. docs/api.md, docs/architecture.md) i linkuj do nich z README, aby utrzymać przejrzystość i strukturę.