write-docs

ドキュメントを作成する

このスキルでは、tldraw SDK のドキュメントを作成および更新する方法について説明します。

配置場所

すべてのドキュメントは apps/docs/content/ にあります。主なカテゴリは次のとおりです。

ディレクトリ	目的
docs/	SDK ドキュメントの記事
releases/	リリースノート（write-release-notes スキルを参照）
examples/	サンプルドキュメント
getting-started/	クイックスタートおよびセットアップガイド

手順

1. 範囲を理解する

作成する前に:

• 対象読者（新規ユーザー、経験豊富な開発者、API リファレンス）を特定します
• 関連するトピックを扱っている既存のドキュメントを確認します
• apps/examples/ 内の関連するサンプルを確認します
• ソースコード内の API の型とコメントを読みます

2. ファイルを作成する

適切なディレクトリに、frontmatter を含む新しい .mdx ファイルを作成します:

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

3. コンテンツを書く

次の構成に従います:

1. 概要 — 何を、なぜについて 1〜2 段落
2. 基本的な使い方 — 最もシンプルな動作するサンプル
3. 詳細 — より多くのサンプルを交えた詳しい説明
4. エッジケース — 高度なパターン、注意点
5. リンク — 関連するドキュメントとサンプル

4. MDX コンポーネントを使用する

API リンク

API リファレンスには [ClassName](?) または [ClassName#methodName](?) を使用します:

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

コードのハイライト

特定の行をハイライトするには <FocusLines> を使用します:

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

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

</FocusLines>

画像

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

API ドキュメント用のテーブル

メソッド、オプション、プロパティを一覧にするにはテーブルを使用します:

| 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. 検証する

次の点を確認します:

• コードサンプルが実際に動作すること
• API リンクが正しく解決されること
• 画像に alt テキストがあること
• 見出しが sentence case を使用していること
• AI っぽさがないこと（スタイルガイドを参照）

参考資料

• スタイルガイド: 文体、トーン、フォーマットの慣例については ../shared/docs-guide.md を参照してください。