コンテンツレビュー

はじめに

この手引きは、ヘルプページとリリースノートの「自己チェックとレビュー依頼時の必要事項」を網羅的にまとめ、指針として共有するものです。
レビュー時の迷いを減らし、レビュー相手への負荷を軽減する目的で定義しています。
この手引きはレビューの手段を強制するものではありません。

自己チェック

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

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

レビュー

レビューは、第三者が確認し、品質を担保するために実施します。

レビュイー（レビューを依頼する人）

レビューを依頼する側は、PRのテンプレートに沿って以下の内容を埋めます。

関連リンク
やったこと
（あれば）申し送り・相談
やらなかったこと
キャプチャ
確認方法
マージ後にやること
- 多言語ページの有無
  - 記事のフォルダ内に日本語以外のmdファイルがないかを確認します。
- ページを削除したかどうか
  - 削除した場合
    - #bizでの周知をしたかどうか
    - リダイレクトの設定をしたかどうか

レビュアー（レビューする人）

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

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

以下の観点でレビューします。

表示崩れがないか、画像の幅は適切か。
リンク切れがないか、リンク先は適切か。

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

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

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

ヘルプページの場合：関係者レビュー

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

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

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

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

仕様の確認

レビューの観点：
- 作成時には執筆者が実際に動作確認した内容を記載します。
- そのため、ページの説明と開発者が意図した仕様に差異がないかを確認します。
レビュアー：
- プロダクトマネージャー
- プロダクトエンジニア
- QAエンジニア

ユーザーのペインに適っているかの確認

レビューの観点：
- ヘルプページを読んだユーザーが問題なく仕様を理解し、操作できそうかを確認します。
- ユーザーからのお問い合わせ起因の修正・作成の場合、ユーザーがヘルプページを読んで問題を自己解決できそうか、お問い合わせ対応の負荷が軽減しそうかなどを確認します。
レビュアー：
- プロダクトマーケティングマネージャー
- プロダクトデザイナー
- カスタマーサポート
- カスタマーサクセス

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

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