Toolverse
All skills

write-docs

by tldraw

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

Installation

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

Installation

Quick info

Author
tldraw
Category
Frontend
Views
61

About this skill

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

How to use

  1. Zidentyfikuj grupę docelową dla dokumentacji (nowi użytkownicy, doświadczeni deweloperzy, referencja API) i sprawdź istniejące artykuły na podobne tematy, aby uniknąć duplikacji.
  2. Zapoznaj się z odpowiednim kodem źródłowym i przykładami w katalogu apps/examples/, aby zrozumieć funkcjonalność, którą dokumentujesz.
  3. Utwórz nowy plik .mdx w odpowiednim katalogu (docs/, getting-started/, examples/ lub releases/) z frontmatter zawierającym tytuł, status, autora, datę, kolejność i słowa kluczowe.
  4. Napisz zawartość zgodnie ze strukturą: najpierw przegląd (1-2 akapity co i dlaczego), następnie podstawowe użycie (najprostszy działający przykład), szczegóły z dodatkowymi przykładami, przypadki brzegowe i zaawansowane wzorce.
  5. Używaj komponentów MDX do odwołań API (np. ClassName lub ClassName#methodName) i wyróżniania linii kodu za pomocą FocusLines.
  6. Dodaj na końcu linki do powiązanej dokumentacji i przykładów, aby ułatwić nawigację użytkownikom.

Related skills