はじめまして。ひつじです。
TechBoosterというウェブサイトでAndroidなどの記事をかいてます。Qiitaには初めて投稿します。
vvakameさんの技術的な文章を書くための1歩、2歩、3歩 を見る人の補助的な気持ちで0歩目を紹介します。
記事の構成方法については、vvakameさんの記事で触れられてることもあり、あまり触れません。
読みやすい文章のための心得をまとめました。
0歩というぐらいなので普段から気を付けている（そして完璧には、こなせていない）内容をまとめています。ただ内容については私自身が気を付けていることですので、もっと皆さんにあった良い方法があるかもしれません。参考になれば幸いです。
文章を書くのに大切なことって？
- 言いたいことを1つに絞る
１つの文章にたくさんの主張を入れると読む人は混乱してしまいます。ですので、なるべく1つのコンテキスト（章、節、項で主張の大小はあります）では、言いたいことを１つ主張するようにしてください。
文章に興味を持ってもらうには？
- まとめ（アブスト）を最初にかく
読者はあなたの主張を読みたがっています。数あるウェブサイト、雑誌、書籍のなかから偶然にも興味をもって読んでくれています。しかし、最後まで読んでみて期待した内容でなかった時の残念感は計り知れません。
最初にまとめをのせることは読者と記事のマッチングをとるためでもあります。まとめでは主張の魅力を最大限伝えてください。まとめが良ければよいほど最後まで読んでもらいやすくなります。
文章を理解してもらうには？
ここでは文法的な、または文章として読みやすくする工夫を紹介します。ちょっとしたことなのですが、すべてを守ろうとおもうと意外に難しいものです。以下に3点のポイントに絞って、まとめました。
- 文章は短く、簡素に書く
長い文章は、主語、述語の対応が取りにくく（筆者の国語力もありますが）主張があいまいになりがちです。経験的に技術文章で3行を超える文章（句点「。」で区切られていない長文）は読みづらく感じます。
まれに長くても面白い文章を書く人がいるのですが、一般的なノウハウというより国語的な才能の場合があります。技術的な文章であれば修飾的な表現は割り切って簡潔に伝えましょう。
- 初出の用語/概念は説明する
書いていると用語解説を忘れることがあります。「文章を書く」という作業は言い換えるならば筆者の主張や考えをまとめる、という行為です。
そうして出てきた単語は、筆者の中では既知のものとなっており説明不要と思い込んでしまうことがままあります。読者にとっては初めて出てきた単語は未知の物体Xであり、理解の妨げになることを十分留意して下さい。
- 表現を統一する
ささいなことですが読みやすさに最も影響します。国語的なことではありますが筆者が主張を文章に落とし込んだあとは、その文章があなたの主張、意見そのものとして読まれます。
読みやすさを気にしてしすぎる、ということはありません（もちろん著者の書くモチベーションや勢いも大事なので最後にチェックするといいでしょう）。
表現チェックリスト
ここで紹介する内容は～しなければならない！といった強制的なものでありません。特に雑誌や書籍では出版社ごとに異なる方針のものもあります。ですので、読みやすさの参考程度にしてください。たとえばウェブの記事であれば多少ライトな表現のほうが読みやすく感じます。
- 表現を統一する： 著者、書き手、筆者、執筆者＝著者でまとめる
- 用語を統一する： onCreate()／onCreateメソッド／Activity#onCreate()
- 開きを統一する： ～出来る／～できる、～する事／～すること など漢字の開きを合わせる
- 指示語を減らす： あれ、それ、これ、前述の～、など。何を指しているか明確か？確認する
- 記号は意識する： ()や「」、『』の使い分けを統一する
- ～と思います：～です。で改めることを薦めます。事実、現象であれば断定系で構いません
さらに一歩踏み込んで
細かい話になるので例を使って確認してみましょう。もっとも表現方法は千差万別ですので著者の書いた文章中で統一されていれば問題ありません。文章の品位を上げる作業といえます。
これは作例です（テストです。)
という文章があったとします。私の場合は以下のように順次考えて、なおしていきます。
これは作例です（テストです)。
句点「。」の位置を文章の最後に変えました。
これは作例です（テストです）。
「（）」が全角と半角だったので全角にあわせました。
これは作例（テスト）です。
「です」が重複していることに気づいたので片方を消しました。
これら細かい推敲は、書きながら（ほぼ勝手に）脳内で行われている作業です。
実際、執筆を複数回に分けていたり長時間にわたって書いていたりすると経験上、マチマチになってしまいます。
推敲する
- 書き終わったら自分で読む
書き終わったら、いったん気持ちをリセットして読者視点で文章を読んでみてください。なおしたいところが出てきたら修正してまた読む。気にならなくなるまで繰り返します。一見すると単純ですが、自分が書いた文章は自分が一番よく理解しているので、意外に難しい作業です。
最後に
技術的な文章を書くための0歩として「読みやすい文章のための心得」を紹介しました。
0歩にしては細かいところから考え方まで幅広かったので結構めんどくさいですね。
もちろん最初からすべてを完璧にできる人はいません。私自身も試行錯誤の連続です。あなたが自分なりの書き方、表現方法を考えるきっかけになったのであれば、この記事の目的は達成されたといえます。
何度もくりかえしになりますが読者にとって大事なのは筆者の主張です。
Qiitaのような場所では、みんなが技術文書を読みたがっています。今読んだことを活かす為にも、さっそくひとつ書いてみませんか？
それでは良い執筆ライフを：）