Toolverse
Wszystkie skille

docs-writer-reference

autor: reactjs

Pisz referencje React zgodnie ze standardami – szablony, struktury i wytyczne stylu

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
reactjs
Kategoria
Frontend
Wyświetlenia
3

O skillu

Umiejętność dla Claude/Copilot do tworzenia stron referencyjnych dokumentacji React. Zawiera szablony dla haków, komponentów, konfiguracji, dyrektyw i reguł ESLint. Definiuje głos i styl techniczny – precyzyjny, neutralny, bez hedgingu. Obejmuje drzewo decyzyjne do wyboru typu strony, sekcje obowiązkowe (Parameters, Returns, Caveats), zasady formatowania oraz przykłady. Integruje się z umiejętnościami /docs-components i /docs-sandpack.

Jak używać

  1. Zainstaluj umiejętność docs-writer-reference w swoim środowisku Claude lub Copilot, wskazując repozytorium reactjs/react.dev. 2. Przed napisaniem strony referencyjnej przejdź przez drzewo decyzyjne: określ, czy dokumentujesz Hook, komponent React, opcję konfiguracji, dyrektywę, regułę ESLint czy indeks wielu API. 3. Wybierz odpowiedni szablon (Typ A–F) na podstawie wyniku drzewa decyzyjnego – każdy typ ma własną strukturę sekcji. 4. Napisz jednowierszowy opis na początek (np. "useState to React Hook, który pozwala..."), następnie dodaj sekcje Parameters, Returns i Caveats; dokumentuj rzeczywiste przypadki brzegowe, które napotykają programiści. 5. Zachowaj ton autorytetu technicznego – stwierdzaj fakty, nie korzyści; unikaj języka rozmownego i wyjaśnień "dlaczego chciałbyś to użyć". 6. Dla komponentów i przykładów kodu odwołaj się do umiejętności /docs-components i /docs-sandpack; zawsze dołącz InlineToc i linki "Zobacz więcej przykładów poniżej".

Podobne skille