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

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

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

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

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

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

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

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

見やすいように改行による空白を適宜いれます。
PCのブラウザでは2〜3行(約2文章)書いたら一回改行入れた方が見やすいです。

箇条書きはScrapbox, Helpfeelでは文頭のスペースで書きます。
「・」記号や「■」記号の利用も避けます。

米印「*」を用いた太字にする基準を決めます。
見出し
見出しが増えすぎる場合は、ページ自体の分割を考えます。
強調したい表現

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

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

日本語の間違いは直します。
『しずらく』→『しづらく』

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