VRChat 非公式日本語ドキュメント

アクセシビリティ

ドキュメントを適切に構成し、有用なメタデータを提供することで、よりアクセシブルで包括的なドキュメントにすることができます。

このページでは、Googleが公開している無料のTech Writing for Accessibilityコース(CC BY 4.0)の要点をまとめています。

平易な言葉を使う

VRChatの制作ドキュメントを読むユーザーの多くは英語話者ですが、複雑な単語やフレーズを理解できない可能性があります。

  • 馴染みのない専門用語、米国特有のスラング、ポップカルチャーの引用、複雑な文法構成は避けてください。
  • ドキュメントの明確さを高めるには、スタイルガイドに従ってください。

役に立つ見出しを作る

Markdownは異なるレベルの見出しに対応しています。見出しはドキュメントの構造を改善し、読者が内容を理解する助けとなります。

  • すべてのドキュメントで、タイトルにはレベル1の見出し(#)を使用してください。
  • その他の見出しレベル(#####...)を使用してセクションを作成してください。
  • 見出しのレベルを飛ばさないでください(例:## から ##### へジャンプする)。

スクリーンリーダーを使用するユーザーは、ページをスキャンしてリンクだけを読み上げさせることがよくあります。「詳細はこちら、詳細はこちら、詳細はこちら」のような単調なものではなく、意味のある情報を伝えられるよう、分かりやすいリンクテキストを使用してください。

役に立つ代替テキスト(alt属性)を書く

Markdownでは、画像に対して代替テキストを提供できます。スクリーンリーダーは、視覚障がいのある方や弱視の方のために、この代替テキストを読み上げます。

短いフレーズや1〜2文で記述してください。長い説明は、スクリーンリーダーを利用している方の読書体験を妨げてしまいます。

  • 「〜の画像」や「〜の写真」といった不要な言葉は含めないでください。
  • 最初の単語を大文字にし、文末にピリオドを付けてください。
  • 必要に応じて、その他の句読点を使用してください。

例:

![An avatar with a backpack walks into a blue, holographic world. It's surrounded by floating objects from Unity and Udon.](/img/homepage/ill-overview.png)
http://creators.vrchat.com

バックパックを背負ったアバターが、浮遊するUnityオブジェクトやUdon Graphの要素がある青いホログラフィックの世界に歩いて入っていく様子。

最終更新: