ヘルプセンター

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

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

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

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

ヘルプページのタイプ

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

1. 機能概要

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

どのように読まれるか

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

どうやって伝えるか

2. 操作手順

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

どのように読まれるか

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

どうやって伝えるか

3. 仕様の一覧

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

どのように読まれるか

ページを通して読まずとも、目当ての仕様をピンポイントで確認できる。

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

  • 操作時に起こったトラブルの解決やエラーメッセージの意味、仕様に関する質問など、個別の疑問を解消する情報を伝えます。SmartHRヘルプセンターでは「よくある質問」と呼んでいます。

どのように読まれるか

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

どうやって伝えるか

5. 用語

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

リリースノート

リリースノートは、機能追加や不具合修正の内容など、アプリケーションのアップデートの詳細をユーザーに伝えるために公開します。
変更点の羅列ではなく、「ユーザーがどういう風に使えるようになったか」を意識した書き方について説明します。

フィードバック先

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