Écrire de la documentation

Cette skill couvre comment écrire et mettre à jour la documentation du SDK tldraw.

Localisation

Toute la documentation se trouve dans apps/docs/content/. Les catégories principales sont :

Répertoire	Objectif
`docs/`	Articles de documentation du SDK
`releases/`	Notes de version (voir skill write-release-notes)
`examples/`	Documentation des exemples
`getting-started/`	Guides de démarrage rapide et de configuration

Processus

1. Comprendre le périmètre

Avant d'écrire :

Identifiez le public cible (nouveaux utilisateurs, développeurs expérimentés, référence API)
Vérifiez la documentation existante qui couvre des sujets connexes
Examinez les exemples pertinents dans apps/examples/
Lisez les types d'API et les commentaires dans le code source

2. Créer le fichier

Créez un nouveau fichier .mdx dans le répertoire approprié avec du frontmatter :

---
title: Feature name
status: published
author: steveruizok
date: 3/22/2023
order: 1
keywords:
  - keyword1
  - keyword2
---

3. Écrire le contenu

Suivez la structure :

Overview — 1-2 paragraphes sur le quoi et le pourquoi
Basic usage — L'exemple fonctionnel le plus simple
Details — Explication approfondie avec plus d'exemples
Edge cases — Motifs avancés, pièges courants
Links — Documentation et exemples connexes

4. Utiliser les composants MDX

Liens API

Utilisez [ClassName](?) ou [ClassName#methodName](?) pour les références API :

The [Editor](?) class has many methods. Use [Editor#createShapes](?) to create shapes.

Mise en évidence de code

Utilisez <FocusLines> pour mettre en évidence des lignes spécifiques :

<FocusLines lines={[2,6,10]}>

\`\`\`tsx
import { Tldraw } from 'tldraw'
import { useSyncDemo } from '@tldraw/sync'
\`\`\`

</FocusLines>

Images

<Image
    src="/images/api/events.png"
    alt="A diagram showing an event being sent to the editor."
    title="Caption text here."
/>

Tableaux pour la documentation API

Utilisez des tableaux pour lister les méthodes, options ou propriétés :

| Method                   | Description                                    |
| ------------------------ | ---------------------------------------------- |
| [Editor#screenToPage](?) | Convert a point in screen space to page space. |
| [Editor#pageToScreen](?) | Convert a point in page space to screen space. |

| Value     | Description                                          |
| --------- | ---------------------------------------------------- |
| `default` | Sets the initial zoom to 100%.                       |
| `fit-x`   | The x axis will completely fill the viewport bounds. |

5. Vérifier

Vérifiez que :

Les exemples de code fonctionnent réellement
Les liens API se résolvent correctement
Les images ont du texte alternatif
Les titres utilisent la casse de phrase
Aucun indicateur IA (voir guide de style)

Références

Style guide: Consultez ../shared/docs-guide.md pour les conventions de voix, de ton et de formatage.

write-docs