ブログ

仕様書や議事録、こういったブログ記事のような情報発信など、エンジニアはコードだけでなく文章を書く機会も多いです。
上手な文章の書き方や文章構成のコツなどは、少し調べればたくさん情報を得ることができます。
AIがいい感じの文章を作ってくれる時代にもなりました。
それでも、色々注意して書き上げたのに読みにくい・伝わり辛いといったことがないでしょうか。
それはちょっとしたことで改善できるかもしれません。

今回は自分で文章校正するときに気を付けている点や、レビューで指摘しがちな内容を”文章を書いた後の”チェックポイントとしてまとめてみました。

誤字脱字がないか探す

当たり前ながら、誤字脱字は重要な修正ポイントです。
特にサービス名は綴り間違いや大文字小文字・スペースの有無などを間違いやすいので、正式名称で表記するように気を付けています。

例

× github
○ GitHub

正式名称が長い場合は最初に書いておいて以降を略称表記にする手もあります。

例

Visual Studio Code（VSCode）

略称や通称が伝わるかどうか考える

私たちエンジニアが当たり前に使う言葉も、万人に通じるとは限りません。
言葉やその意味を理解してもらえるかどうかを考えて、伝える相手によって説明を入れるなどの配慮ができると良いですね。

例

• DB（データベース）
• UI（ユーザーインターフェース）
• ステージング環境

表記を統一する

文書内で言葉の意味や書き方の表記揺れがないようにします。

例

• サーバー ／ サーバ
• ユーザーid ／ 会員ID
• 1番目 ／ 二番目
• （全角記号） ／ (半角記号)
  • かっこは左右で全角半角が混在しているパターンもたまに見るので要注意

”ですます調”・”である調”を統一する

基本的には統一すべきです。
とは言え”である調”で書いていてなんとなくトゲがある印象になるときもあるので、よほどキッチリした文書でなければ”ですます調”を混ぜても良いかなと思っています。
あとは文末に句点「。」をつけるかつけないかも統一した方が良いでしょう。

例

【議事録】
- 〜の場合はどうなるのか（お客様）
  - 確認する（ウイングドア）

と書くと威圧感があるので…

- 〜の場合はどうなるのか（お客様）
  - 確認いたします（ウイングドア）

と書いても良さそう。

くだけた表現を避ける

例えが難しいのですが、話し言葉のような表現は避けた方が良い場合もあります。
ブログ記事ではあえてくだけた感じに書くのもアリですね。

例

× 最初は一部隠れてて、いる項目だけ出しとく。ボタン押したら全部見れます。
○ 初期表示では一部隠しておき、必要な項目のみ表示する。「詳細」ボタンを押すと全て確認できる。

（修正後も仕様の表記としては変ですが、あくまでくだけた表現の修正例として読んでください🙏）

読点を適度に入れる

長い文章に読点がなかったり、反対に多すぎたり位置が不自然だと読みにくくなってしまいます。
適度に読点を入れ、長すぎる文章は分割すると伝わりやすくなります。

例

× 読点がなくて読みにくい
読点とは「、」のことですが長い文章に全く読点がないと読みにくいので適度に入れていくことで可読性を上げることができるため読みやすい文章を書く際に効果的です。

× 読点が多い・位置が不自然
読点とは、「、」のことですが、長い文章に全く読点がないと、読みにくいので適度に入れていくことで、可読性を上げることができるため、読みやすい文章を書く際に効果的です。

○ 適度に読点を入れ、文章を分割する
読点とは「、」のことです。
長い文章に全く読点がないと読みにくいので、適度に入れていくことで可読性を上げることができ、読みやすい文章を書く際に効果的です。

○ このぐらい分割しても良いかも
読点とは、「、」のことです。
長い文章に全く読点がないと読みにくいので、適度に入れていくことで可読性を上げることができます。
読みやすい文章を書く際に効果的です。

参照先を明確にする

別途参照先がある場合は、ファイル名やスプレッドシートのシート名、システムの画面名などを正しく表記することで認識齟齬の防止につながります。

フォントを統一する

文章でなく文書の話になりますが、フォントの色やサイズ、線の色やスタイルが一部違っていたりすると個人的にはとても気になります。
後から貼り付けた文字だけスタイルが変わったりしていないでしょうか。
気にする人は気にするところだと思うので、気を配っておいて損はないでしょう。

最後に一通り読み返す

これが一番大事だと思います。
あれこれ考えながら書いていると、いつの間にか文法が変になっていたりするものです。
これまで挙げてきた注意点も読み返すことで発見できたりします。
できれば一旦時間を置くと、より客観的に読める気がするのでオススメです。

レビューしてもらう

ここまで自分でチェックをした上で、可能な限り第三者に読んでもらうとより効果的です。
もし不安があれば、すべて書き上げてしまう前にざっくり構成段階で見てもらうと軌道修正しながら進められて効率的かと思います。

まとめ

どれも初歩的なことですが、書いている最中や自己レビューだと見落としがちだったりします。
せっかく良いことを発信していても、文章ミスだらけであったり読みにくいと非常に勿体無いです。
簡単なことで文章の説得力を上げられるかもしれませんので、少しだけ気にしてみてはいかがでしょうか。

株式会社ウイングドアは福岡のシステム開発会社です。
現在、私達と一緒に"楽しく仕事が出来る仲間"として、新卒・中途採用を絶賛募集しています！
ウイングドアの仲間達となら楽しく仕事できるかも？と興味をもった方、
お気軽にお問い合わせ下さい！