ヘルプセンター

ヘルプセンターガイドラインとは

SmartHRヘルプセンターに掲載しているヘルプページの作成に関するガイドラインです。

ヘルプページのライティングは、基本的にプロダクトデザインにおけるライティングガイドライン用字用語に準拠しますが、ユーザーのメンタルモデルに配慮して特例を設けているケースがあります。
詳しくは、ヘルプページのライティングパターンなどを参照してください。

ヘルプページの基本的な考え方

ユーザーの関心事は何かを念頭に、どこまで説明が必要か、どう見せると伝わるかを考えます。
多すぎる情報はノイズになるので、取捨選択し、ページを設計します。

ヘルプページのタイプ

ヘルプページを情報の種類ごとに、下記のタイプに分類します。

1. 機能概要

  • 「この機能とはどういったものであるか」を説明したもの。ユーザーがアプリケーションを使いこなすうえで理解しておきたい、機能の定義や設計思想を伝えます。
  • ドメイン知識を理解し、開発時に想定したユースケースとユーザーのメンタルモデルを橋渡しすることを考えます。
  • ヘルプページの中では、もっとも書くのが難しいタイプのページです。

どのように読まれるか

  • 機能の概要(全体感)、機能を使用するユーザーメリットを理解できる。

2. 操作手順

  • 機能の操作を順序立てて説明したもの。

どのように読まれるか

  • ユーザーが達成したい操作について、手順や注意点を確認できる。

3. リファレンス

  • 設定項目一覧や、一定条件における制限など、情報を網羅的にまとめたもの。

どのように読まれるか

  • 仕様について辞書的に閲覧し、機能を把握できる。

4. トラブルシューティング・FAQ

  • 操作時に起こったトラブルの解決やエラーメッセージの意味、仕様に関する質問など、個別の疑問を解消する情報を伝えます。SmartHRヘルプセンターでは「よくある質問」と呼んでいます。
    • エラーやイレギュラー時の対応方法(こういう時はどうすればいいの?)
    • 問い合わせが多い内容(こういうことはできるの? 「磁気媒体CSV」って何? 「操作できる範囲」って何?)

どのように読まれるか

  • 特定の疑問やエラーを解消できる。

どうやって伝えるか

5. 用語

  • アプリケーション内で使用している用語の定義を説明します。
  • 2022年1月時点では、人事評価機能でのみ掲載しています。

フィードバック先

気になることがあったときには、気軽にUXライターに声をかけてください。
また、記載内容に関する質問や依頼は、社内Slack#design_system相談チャンネルにワークフローも用意しています。こちらも利用してみてください。

次へ