コードレビュアーのブログアドバイス 〜 part 1 : 条件文とみなして冗長な文をすっきりさせる

フロントエンドエンジニアの茶木です。
コードレビューの知識を流用した、普通のブログ（テックブログに限定しない）をすっきり読みやすくする視点について共有します。

コードレビューはブログ執筆のアドバイスに通じる

Gaji-Laboブログはメンバーでローテーションを組んで更新しています。記事の内容はメンバー間でレビュー（アドバイス）を行うことで、クオリティ向上に努めています。

ブログのレビューを重ねることで気がついたのですが

ブログの文章のアドバイスはコードレビューのテクニックが流用できる

のではないかということです。

冗長な表現はないか

同等の意味なら短い文章の方が読みやすいです。コーディングも一緒ですね。
いくつか短くするポイントがありますが、コーディングの条件分岐のレビューに近いと感じました。

否定文・受動態を避ける

• 否定文を肯定文に直す
• 受動態を能動態に直す

上記2つは、文章をすっきりさせる銀の弾丸です。
この視点は「条件判断文」のコードレビューと似ています。
わざとらしいですが、例文です。

情報が共有されない場合、認識の乖離はなくならない

なにかごちゃごちゃしていますよね。

情報を共有すれば、認識は一致する

まず二重否定を消し、適切な反対語があれば単純な否定形も解消します。さらに受動態も能動態に置き換えを検討します。文脈から文章の意味が大きく変わらないと判断できればOKです。

条件文を減らす

コードレビューの視点: ネストを減らす、ネストから早く抜ける

こちらは実際に条件文です。文章中の「のとき・の場合」「してから・の前に」などの、限定や順序の条件に注目します。

読みにくいと感じる場合は、以下のケースに該当します

• 条件が複数ある（ネストが深い）
• 条件のあとの文が長い（ネストの中が長い）
• 分岐が複数ある

解消方法ですが、コーディングと考え方は近いです。

• 無視できる条件を外す
• 条件を一箇所にまとめて書く
• 条件のあとに続く文章が短くなるように順序を変える（ネストから早く抜ける）

「無視できる条件を外す」は実際のコーディングと違って、文章上の工夫で比較的容易に達成できます。特に、本筋から外れる例外については省いてしまう方が良いケースもあります。ブログではいちいちガード節を書かないのです。

また、分岐が多いが単調な場合は、リストでまとめる方法も有効です。こちらは switch case 文 のイメージですね。

おわりに

コードレビューの視点でブログをレビューする方法についてまとめました。

今日は、文章をすっきりさせることを主眼に話しました。

文章の良さはもちろん内容の正確さや、テーマの選定自体が大きなポイントになります。また実際の文章はコードと違い、文章の味やフレンドリーさ、冗長さが良い方向に働くケースもあります。

複数の視点をもってレビューができるように精進いたします。