日本語ドキュメントを整える

このページについて

このページは、日本語と英数字が混在する技術文書の表示例です。コード中の識別子は原文のまま保ち、本文では操作の目的と結果を具体的に説明します。

最初の設定

1. Framerでテンプレートを複製します。
2. 商品名とナビゲーションを変更します。
3. CMSのDocumentationコレクションで記事を編集します。
4. パソコンとスマートフォンの両方でプレビューを確認します。

読みやすい段落にする

一つの段落には一つの話題を置きます。見出しだけを読んでも全体の流れが分かるように、操作名や確認する内容を見出しに含めます。長い文章を無理に一行へ収めず、適切な行間と余白で読み進められるようにします。

コードの例

本文中では project_id のように識別子を区別します。コードブロックでは改行とインデントを保ちます。

{
  "name": "はじめてのプロジェクト",
  "locale": "ja",
  "status": "ready"
}

設定項目

公開前の確認

• リンク先が正しいことを確認します。
• 長いコードや表が画面全体を押し広げていないか確認します。
• サンプル文と実際の仕様を混同しないように書き換えます。
• 非公開の情報や実際の認証情報が含まれていないか確認します。

次に読む

英語の導入ガイドと同じ構成を使い、必要な説明を追加してください。自動翻訳や多言語URLの同期は、このテンプレートの機能には含まれません。