本文(回答文)を書くコツ

本文(回答文)を書くコツ

本文を作成する際のポイントをまとめます。

主語や目的語を明確に書く
『ログインできない場合』→『お客様が管理画面にログインできない場合』
ペルソナによっては省略した方が文章量が減って読みやすいこともあります。

文中の「・」は避ける
andかorかわかりにくくなるためです。
『パターンA・B・Cの場合は』
『パターン A, B, C すべてに当てはまる場合は』
『パターンが A, B, C のどれかの場合は』

箇条書きの使用
並列する要素が増えて読みづらい場合は、箇条書きに書き換えます。
『条件A〜〜, B〜〜, C〜〜, D〜〜, E〜〜, F〜〜の場合は』→『以下のいずれかの条件にあてはまる場合は』

スタイルガイドを決めて記号を使い分ける
例:「」を名称や用語、UIに使うと決めて、その基準を全ページで踏襲します。
『そのまま次へのボタンをクリックします』→『そのまま「次へ」のボタンをクリックします』
UIに「」を使用すると決めたら、他の意味で「」を使わないようにします。
「」、『』、【】、()、<>などを正しく使い分けます。
全角の()か半角の()か、見栄えも考慮してルールを決めます。

1ページあたりの文書量が長くなりすぎないように書く
文章量が多くなると、読む側が目的の事柄を探しにくくなります。
質問文の数が多くなりすぎるのを回避できます。
ペルソナがスマートフォンのユーザーや、若い方/お年寄りの方には特に気をつけてください。
長くなりそうな場合は別のページに分割して、元記事と関連付けてリンクします。
見出しが必要でも、1ページ内に複数の見出しがあり、階層ができてしまう場合はページの分割の対象とします。

本文が完成した時、改めてタイトルに対して本文が適切かを読み直す
何かの定義であれば、その定義が冒頭に書かれているか確認します。
「〜できない」のようなトラブル関連であれば、そのトラブルに対する対処法が簡潔に書かれているか確認します。

改行による空白を適切に使い、読みやすさに考慮する
PCのブラウザでは2〜3行(約2文章)書いたら一回改行入れた方が見やすくなります。

箇条書きは文頭にスペース入れる
Helpfeelの編集画面 (Scrapbox) では、文頭にスペースまたはタブを入れることで、箇条書きの中黒(・)を挿入できます。
「・」記号や「■」記号の利用も避けます。

太字にする基準(アスタリスク「*」を使用する対象)を決める
見出し
見出しが増えすぎる場合は、ページ自体の分割を考えます。
強調したい表現

本文に統一感を持たせるため、文書のテンプレートを作成する
結論
詳細
補足情報

一文は一義〜二義にする
一般的には一文一義ですが、全部一文一義にこだわると機械的な文章になることがあります。

日本語の間違いは修正する
『しずらく』→『しづらく』

二重否定を避ける
『反対しないとも限りません』→『反対する場合があります』
Powered by Helpfeel