docs
Skill do pisania dokumentacji technicznej w stylu zwięzłym i przystępnym
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill dla Cursor/Copilot, który naucza Cię pisać dokumentację techniczną bez zbędnych słów. Wymusza krótkie sekcje, przyjazny ton i czytelną strukturę. Idealne do tworzenia instrukcji, poradników i referencji API. Bazuje na sprawdzonych wzorcach — patrz przykład w /packages/web/src/content/docs/docs/index.mdx.
Jak używać
Zainstaluj skill w swoim projekcie Cursor, umieszczając plik docs w katalogu .cursor/skills.
Otwórz dokument, który chcesz napisać lub edytować, a następnie wyzwij skill docs — Cursor użyje go jako instrukcji dla AI.
Zacznij od tytułu strony — jedno słowo lub fraza 2–3 wyrazowa, bez zbędnych słów.
Dodaj krótki opis w jednej linii (5–10 słów), unikając powtórzeń tytułu i słowa "The" na początku.
Podziel treść na sekcje rozdzielone trzema myślnikami (---). Każda sekcja powinna mieć krótki tytuł w trybie rozkazującym (np. "Zainstaluj", "Skonfiguruj"), z wielką literą tylko na początku.
Pamiętaj, że każdy akapit to maksymalnie 2 zdania — skill wymusza zwięzłość i czytelność. Jeśli committujesz zmiany, poprzedź wiadomość prefiksem "docs:".