マニュアルをGoogleサイトで作ってみました


Webアプリの開発をしてると必ず、納品先から「操作マニュアルみたいなの作ってください」って言われます。

単純な「どこに何を入力すればいいか」は、そのページのUIを改善すれば説明は不要だと考えています。

しかしながら、全体のワークフローで「こういう場合は、どのページを見て、何をすればいいか」といった場合は、マニュアル(説明書)が必要になります。

READMEファイル(テキストファイル)では、画面上の具体的な表現が難しかったりするので、ドキュメントファイルに章立てて書き起こしたりしていました。

それを今回は、Googleサイトを使って、オンライン化して見ました。

ドキュメントファイルのメリット・デメリット

従来は、Word(Pages), PowerPoint(Keynote)などのドキュメントアプリで作った説明書をPDFファイルに書き出して納品先に納めていました。

操作画面のスクリーンキャプチャなどを使い、分かりやすいし、印刷して手元に用意できるのが強み(メリット)です。

しかしながら、印刷レイアウト(A4サイズ)に収めるのが難しい場面が度々あります。

また、更新の度に新しいPDFファイルを再配布する手間もあります。

メリット

  • (テキストファイルよりも)分かりやすい表現が可能

デメリット

  • 印刷レイアウトに収めるのが難しい
  • 更新の度に、新しいPDFファイルを再配布する手間

オンラインマニュアルのメリット・デメリット

マニュアルをオンライン化することで、「常に最新の情報」を提供できるようになります。

また、ページ間のハイパーリンクを利用できるので、閲覧性を高めることができます。

今回は、旧来のGoogleサイト(新しいGoogleサイトではない)を使用したので、スマホなどからの表示は、ちょっと残念な感じにはなりますが、管理マニュアルという特性上、問題ないと判断しました。

メリット

  • (テキストファイルよりも)分かりやすい表現が可能
  • 最新の情報を常に提供できる(更新が簡単)
  • (一応)印刷用レイアウトも用意されている(Googleサイト)
  • アクセス権限の設定ができる

デメリット

  • 閲覧にインターネット接続が必要
  • 印刷した時、改ページで余分な余白が出る

新しいGoogleサイトを使わなかった理由

昨年、新しくリリースされ、完全リニューアルされたGoogleサイトですが、現在では旧来のGoogleサイトと両方利用可能です。

今後、新しいサイトに統合される案内がされています。

しかしながら、今の完成度で統合されると非常に不安な点がいくつかあります。

統合のXデーまでに、改善を期待したいところです。

ここがダメ

  • 目次の自動作成がない(見出しテキストを自動で目次にしてほしい)
  • ページ内リンクの設定が面倒(HTMLソースを書かないといけない)

ここはGood

  • レスポンシブデザインでスマホ対応
  • 編集画面のレスポンスが良い
  • ドラッグ&ドロップで画像やメディアファイルを追加できる
  • デザインテンプレートがイマドキ風