Toolverse
All skills

docs-writer-reference

by reactjs

Reference page structure, templates, and writing patterns for src/content/reference/. For components, see /docs-components. For code examples, see /docs-sandpack.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
reactjs
Category
Frontend
Views
3

About this skill

Reference page structure, templates, and writing patterns for src/content/reference/. For components, see /docs-components. For code examples, see /docs-sandpack.

How to use

  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".

Related skills