執筆ルール

用語

説明文は日本語を基本とします。英語のUI項目名はそのまま使用し、Wiki独自の翻訳は作りません。プラグイン側で翻訳されている項目は 日本語表記（英語の原項目名） と記載します。

データのキーや識別子は radius や refActorType のように、原表記を維持します。UIの表示名と保存データのキーを混同しないでください。

記事の形

一記事につきひとつの目的を扱います。作例では、完成結果、前提条件、手順、設定値と理由、取り込み用データ、関連ページの順で説明します。スクリーンショットだけで操作を伝えないでください。

確認状態と出典

ソース確認だけの場合は、実機で動作確認済みと記載しません。関連する処理へのリンクは上流の既定ブランチ main を指します。説明を書いた時点のコミットは、記事の sourceCommit に残します。実機確認を追加するときはバージョン、日付、対象の設定と結果を本文に記録します。

推測は確定事項と分けます。ソースを追っても分からない内容は、分からないまま記録し、もっともらしい説明で埋めません。

Markdownと画像

通常の記事は .md で書きます。独自のVue部品は操作できる作例など必要な箇所に限定します。

画像は docs/public/images/記事の名前/ に置き、本文では /images/記事の名前/画像.png のように参照します。代替テキストには何を示す画像か記載してください。

テンプレート

リポジトリ内の templates/reference.md と templates/example.md を基準に記事を追加してください。公開する記事には未記入のテンプレートをそのまま掲載しません。