こんにちは。サイボウズでテクニカルライターをしている小林（@kbys_psb）です。このブログは、テクニカルライター/ローカライズ リレーブログの7本目の記事です。
みなさんは文章を書くときに、考えることや気にすることが多くて、執筆や推敲に時間がかかってしまった経験はありますか？また、ほかの人が書いた文章をレビューするときに、何をどこまでチェックしたらよいか判断に迷ったことはありますか？
そんな自分たちの経験から、ヘルプ制作に必要なライティングの観点を洗い出して、まとめることにしました。
どういうものを作るか
- チェックリストではなく、ヘルプ制作に必要なライティングの観点をまとめる
- 執筆時の指針となるだけでなく、レビュー時にどこをチェックしたらよいかの指針にもなる
- タスクごとに当てはまる項目、または当てはまらない項目が取捨選択できる
- いきなり完成形を目指さず、ブラッシュアップしていく
- 用語一覧や執筆規約は別途用意する
ねらい
- 書く人にとって、執筆時に考えることが明確になり、検討漏れや考慮漏れが減る
- レビューする人にとって、評価基準が明確となり、効率的にフィードバックできる
- チームにとって、人による観点のバラつきがなくなり、品質基準がそろう
どういう観点をピックアップしたか
ここで、ヘルプでのライティングに必要な観点としてまとめたものを一部紹介します。
仕様
正確さ
- 仕様書の記載と合っているか
- 実際の操作と合っているか
操作性
- 操作に必要な情報が書かれているか（注意事項や事前設定）
- できないことやできることが書かれているか
地域性
- 製品を提供する地域や言語に合わせた記述になっているか
情報設計
検索性
- 情報を探しやすい状態（位置やタイトル）になっているか
- 情報の対象者が早い段階で理解できるか
- 情報の対象外の人にとって不要な情報と早い段階で理解できるか
- 別のページにある情報を前提として説明するときに、前提情報への導線があるか
情報の粒度や順番
- 全体的な話から詳細な話の順に書かれているか
- 重要な話から補足の順に書かれているか
- 初出の情報を書くときに、説明された上で書かれているか
- 具体例を書くときに、何を具体化した話か分かるように書かれているか
文章
導入
- タイトルやリード文で、そのページを読み進めるべきかが判断できるか
- タイトルやリード文で、ユーザーのしたいことが実現できるか、または実現できないかを判断できるか
表現
- 一文一義になっているか
- 文章に必要な要素で構成されているか
- そうとしか意味が取られないように書かれているか
- 書かれている視点が一貫しているか
- 読むスピードで理解できる文章になっているか
- 翻訳しやすい文章になっているか
- 主観や解釈が含まれない文章になっているか
規約・用語
- 用語集や執筆規約に沿った表現を使用しているか
- 同じものを表すときに同じ言葉を使っているか
- 読み手にとって馴染みのある言葉を使っているか
図・画像
- 図や画像だけに頼らず、文章でも同等の説明が書かれているか
リンク
- リンク先にどんな情報があるかが説明されているか
アクセシビリティ
- 情報を伝えるための画像に代替テキストを設定しているか
- 見た目に依存しないで説明しているか
まとめ
これらはすべてではなく、また完成形というわけではありません。これからも運用していく中で更新していく必要があります。紹介した項目は、ヘルプ制作やテクニカルライターに限らず、文章を書く上で意識したい観点です。どこかでお役に立てたら嬉しいです。
一緒にサイボウズで働いてみませんか？
サイボウズでは、一緒にUI文言を考えたりヘルプサイトを作ったりする仲間を募集しています！ 色々な分野の技術を学びながら、一緒にサイボウズ製品を盛り上げていきませんか？
詳細はサイボウズの募集要項をご覧ください。 cybozu.co.jp
