Skip to main content

基本フォーマット

ドキュメントサイトを運用する上で参照すべきページ構成ガイドを制定します。 ガイドを利用することで、わかりやすく統一感のある構成を決定できる状態を目指します。

ページ構成ガイドライン​

ページは、以下の要素で構成されています。

- タイトル
- リード文
- 見出し
- 本文
    - 文章
    - 画像
    - テーブル
    - リスト
- 注釈

タイトル​

このページにはどんな内容が書かれているか、ユーザがすぐに理解できる表現をします。 サイト内だけでなく、Google検索時や他のページにリンクが貼られた場合にも理解しやすいかを意識してください。

例 コンテンツを作成する

リード文​

このページに書かれている内容の概要を説明します。 2〜3セクションで記載し、必要に応じて画像も利用してください。

見出し​

セクションを分ける際、最初に見出しを記載します。 見出しでは、具体的にこのセクションで何をするのかを表現します。そのため、「〇〇する」と具体的な動作内容を記載してください。 また、見出しはページの目次としても機能するので、本文のアウトラインを把握できる表現にしてください。 見出しにはH2を利用し、セクション内で見出しを分けたい場合はH3〜H4までを利用してください。

本文​

ライティングスタイルに基づいた文章を作成してください。 本文はいくつかの要素で構成されます。それぞれ説明します。

文章​

セクション内で主張したい内容を記載します。 文が長くなりすぎると、主題が不明確になったり、係り受けの関係が分かりにくくなります。1文は50-70文字以内にまとめると読みやすいと言われています。 (70文字を超える場合は、文を分けられないかを検討してください。)

画像​

文章での説明が困難な場合、または画像の方が簡潔に説明できる場合に注釈を加えた画面キャプチャを使用してください。

テーブル​

UIの解説はテーブル形式で作成してください。

リスト​

「〜と〜」や「〜または〜」のように単語をつなぐと文章が長くなり、読みにくい、別の意味としてとられてしまう可能性があります。 並列で並べられる文章の場合は、リスト表記を利用してください。

注釈​

本文とは若干ずれてしまう場合、強調したい注意事項がある場合注釈を利用します。