ヘルプページレビューの手引

はじめに

  • この手引はヘルプページの自己チェックとレビュー依頼時の必要事項を網羅的にまとめ、指針として共有するものです。
  • レビュー時の迷いを減らし、レビュー相手への負荷を軽減する目的で定義しています。
  • この手引はレビューの手段を強制するものではありません。迷ったらお手本とし、必要があればカスタムしてください。

自己チェック

レビューを依頼する前に、自分で下記のチェックを実施しましょう。

プレビュー表示で確認すること

Noチェック観点チェックの内容備考
1誤字脱字はないか文章全体を読み返し、誤字脱字がないか。-
2表記がガイドラインに沿っているか用字用語など、ガイドラインに沿った表現を使用しているか。-
3スタイル・レイアウトの崩れがないか画像のサイズ、注意点やTipsなどの囲み、表などが崩れていないか。意図したサイズ・範囲になっているか。-
4ユーザーにとってわかりやすい表現になっているか社内用語を使っていないか。日本語としてわかりやすいか。冗長な表現になっていないか。誤解を与える表現になっていないか。-
5(依頼されたページの場合)依頼者の課題を解決できているか仕様の変更や、ヘルプページで解決したいことが反映されているか。-
6画像の表示内容が適切か個人情報や開発環境の内容など、不適切な内容が残っていないか。画像がちゃんと表示されているかブラウザのシークレットモード(Zendeskにログインしていない状態)で確認しましょう。
7記載内容は正しいか画像中とテキストで文言が一致しているか。プロダクトの表記・動作と異なる点はないか。-

ソースコード表示で確認すること

Noチェック観点チェックの内容備考
1不要なタグ・属性が入っていないか不要な <span> タグやidなどが設定されていないか。-
2画像(img)タグ内の属性に過不足がないかaltが空になっているか、画像幅は適切に設定されているか、不適切な画像名になっていないかなど。参考:キャプチャ・加工のルール

レビュー

レビューは、第三者がヘルプページを確認し、品質を担保するために実施します。
※2022年1月時点では、UXライターが書いた記事であっても、他のUXライターによるレビューを実施しています。

レビュイー

レビューを依頼する

レビューを依頼する側は、Jiraのチケットに以下の内容を記載します。

## 対象ページ
編集ページのURLを貼る
## やったこと
今回のスコープ内で、何をやったのかを記載する
## やらなかったこと(あれば)
緊急度の高い修正のみ対応した場合や、他ページへの影響が大きいなどの理由からスコープ外としたことを記載する
## 補足
特に確認して欲しい観点や、迷った点などを記載する

レビュアー

レビューする

Noレビュー観点内容備考
1誤字脱字、レイアウト崩れなどのダブルチェック(必須)「自己チェック」の観点でレビュー担当者が再度チェックします。人は誰もがミスをするもの。ケアレスミスを拾うためのダブルチェックです。
2わかりやすい表現になっているか初見で読んだときに、内容がすっと理解できるかを確認します。
3スコープの範囲内で、依頼内容(ヘルプの作成・修正の目的)が果たせているかチケットに「やらなかったこと」が記載されている場合は、スコープを確認したうえでレビューします。チケットのスコープ外のフィードバックも、参考までに伝えると今後の改善につながります。

多言語化ページのレビュー

以下の観点でレビューします。(内容は見てもわからないので、確認不要)

  • 表示崩れがないか、画像の幅は適切か
  • コードに不要なタグが含まれていないか
    • 翻訳工程の関係で、不要なタグが入ることが多い
  • リンク切れがないか、リンク先は適切か

UXライティンググループ内のレビューが不要な場合

下記の場合は、UXライターによるレビューは省略しても構いません。

  • 誤字脱字の修正などの、軽微な修正の場合
  • 関係者レビュー(後述)を受けている場合
    • ただし、誤字脱字などの自己チェックは済ませていることが前提です。

関係者レビュー

新機能はじめ、以下のようなヘルプページは関係者レビューによる確認をする場合があります。

  • 新機能
  • 仕様が複雑な機能
  • セキュリティや料金にかかわる内容で、表現に気を遣う内容
  • ユーザーからのお問い合わせ起因のヘルプ修正・作成

レビュアーとレビューの観点

関係者からレビュアーをアサインする場合には、観点ごとにレビュアーを複数立てます。

  • プロダクトマネージャー、プロダクトエンジニア、QAエンジニア
    • 仕様の確認
    • ヘルプページ作成時には執筆者が実際に動作確認した内容を記載するので、ページの説明と意図した仕様に差異がないかをリリース前に最終確認する役割も果たします。
  • プロダクトマーケティングマネージャー、プロダクトデザイナー、カスタマーサポート
    • ユーザーのペインに適っているかの確認

レビュー依頼時のポイント

  • レビューを依頼する相手がZendeskアカウントを持っていない場合は、プレビュー画面のスクリーンショットやPDFを添付してレビューを依頼しましょう。
    • 部分的な修正の場合、どこを修正したのかを示すと親切です。
  • どういう観点でレビューして欲しいのかを伝えましょう
    • 例えば
      • 仕様面で間違いがないかを確認して欲しい。
      • 他にどういう情報があれば、先回りでお問い合わせを減らせそうか、意見を聞きたい。
      • この内容で、ユーザーの困りごとを解決できそうか?不足はないか?
      • ユーザーは具体的にどんな活用方法をしているのか、この機能で何が達成できるのか。
  • 誤字脱字や細かい表現などの「自己チェック」や「UXライターによるレビュー」で確認できる内容のチェックは不要であることも伝えておきましょう。