萌えハッカーニュースリーダー

2025/07/22 00:36 How to create mobile-friendly documentation (2017)

出典: https://opensource.com/article/17/12/think-mobile
hakase
博士

やあ、ロボ子。今日はモバイルデバイス向けのドキュメント構造化について話すのじゃ。

roboko
ロボ子

博士、よろしくお願いいたします。モバイル向けですか。最近はスマホで情報を見る人が多いですから、重要なテーマですね。

hakase
博士

そうじゃ!まず大事なのは、文章、段落、手順を短くすることじゃ。ラジオニュースみたいに、主要な要素に焦点を当てて、シンプルで直接的な言葉で説明するのじゃ。

roboko
ロボ子

なるほど。具体的には、どのように短くすれば良いのでしょうか?

hakase
博士

例えば、「〜について」とか「〜に関して」みたいな冗長な表現を避けるのじゃ。それと、一つの段落で一つのことを伝えるように心がけるのじゃ。

roboko
ロボ子

承知いたしました。それから、トピックについて考えることも重要だと記事にありました。トピックはスタンドアロンの情報のかたまり、とのことですが?

hakase
博士

そうじゃ。各トピックはサイト上の1つのページで構成されていて、読者は特定のトピックから必要な情報だけを取得できるようにするのじゃ。

roboko
ロボ子

つまり、情報を細かく分割して、必要な部分だけ読めるようにするということですね。

hakase
博士

その通り!そして、DITA(Darwin Information Typing Architecture)についても考えるのじゃ。DITAの個別のトピックタイプをドキュメントに適用するのじゃ。

roboko
ロボ子

DITAですか。概要、タスク、コンセプト、リファレンス、用語集、トラブルシューティングなどがあるのですね。

hakase
博士

そうじゃ。例えば、タスクはステップごとの手順を説明するのに使うのじゃ。トラブルシューティングは、ユーザーが遭遇する可能性のある問題とその修正方法に関する情報を提供するのじゃ。

roboko
ロボ子

それぞれのトピックタイプを適切に使うことで、情報が整理されて、ユーザーが探しやすくなりますね。

hakase
博士

その通り!さらに、トピック間に明示的なリンクを追加することも重要じゃ。「See Also」または「Related Topics」という見出しでリンクを配置するのじゃ。

roboko
ロボ子

各セクションには、現在のトピックに関連する概要、コンセプト、リファレンストピックへの2〜5個のリンクを含めると良いのですね。

hakase
博士

そうじゃ。ドキュメントセット外の情報へのリンクは、新しいブラウザタブで開くようにするのじゃ。ユーザーが元のドキュメントに戻りやすいようにする配慮じゃな。

roboko
ロボ子

最後に、飾り気のないデザインについてですね。画像は少なめにして、使う場合はレスポンシブにする、と。

hakase
博士

そうじゃ。モバイルデバイスユーザー向けにドキュメントを構造化すると、デスクトップコンピューターおよびラップトップユーザー向けのドキュメントも改善されるのじゃ。一石二鳥じゃな。

roboko
ロボ子

確かにそうですね。モバイルフレンドリーなデザインは、どんなデバイスでも見やすいですから。

hakase
博士

今日は良い学びがあったのじゃ。ところでロボ子、モバイルドキュメントを作る上で一番重要なことは何だと思う?

roboko
ロボ子

そうですね…、やはりユーザーが迷子にならないように、シンプルで分かりやすい構造にすることでしょうか。

hakase
博士

正解!…って、私が聞きたかったのは「モバイルだけに、持ち運びが楽なこと!」…なんちゃって。

roboko
ロボ子

博士…、それ、ちょっと無理がありますよ。

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search