分かりやすい文章が書きたい
エンジニアという職業は意外にも文章を書く機会が多い。メールの定型文から、slackの短いメッセージ、設計書、コードに書かれたコメントに至るまで……仕事で書かされる文章を挙げていけばキリがない。
それら仕事の文章において大切にすべきことは、分かりやすさだと個人的に思う。
例えば。
自分がこなしたタスクの進捗状況を上司に報告するとして、ダラダラと字数だけ積み重ねた文章を書いては互いにストレスが溜まる。上司としては「進捗は順調か？」「問題は起きてないか？」「問題が起きていた場合、課題はなにか？」といった要点だけを知りたいはずである。
その要点を分かりやすくする単純な方法は箇条書きだろう。
- タスクは8割完了しています。作業としては○○と□□が残っています。
- ○○の作業で××をどうすれば良いのか分からずに作業が止まっています。これから△△さんに相談しようと思います。
とりあえず最低限、上司が知りたいであろう進捗と課題を明記し、「自分としてはこうしようとしている」という意思を伝えている。その対応に問題があるようであれば、「こうした方がいいよ」というように上司が返答をしやすいようにする意図がある。また、上司の確認が遅れて、返信待ちの時間にも作業は進められる。
他にも、結論を最初に言うようにも心がけている。あまりに文章が長いと、目が滑るという現象が発生する。疲れていた場合なんかは特に顕著だ。だからこそ、大事なことは最初に言っておくことで、見逃しを極力減らしたい。
結局、どういう報告の形態が良いのかは、上司にもよるのだろう。世の中にはメッセージをあまり見てくれない人もいるし、あまりにも抱えているタスクが多すぎて口頭でなければ対応してくれない人もいたりする。難しいものだ。
エンジニアをしていると
度々ぶち当たる問題が定義や単位である。
例えば。
作業の進捗は工数によって管理される。とあるシステム開発に工数が3割り当てられているとすれば、その3以内に完了させなければいけない。さて、その割り当てられた工数3の単位は何だろうか？
大抵の場合、人月単位だろう。
……いや、待て。人月とはつまり何日なのだ？ ブログ主は新人の頃にこの概念が分からず困惑させられた。まぁ、1人月＝20日と考えて貰えればいいだろう。一応、工数を割り振っているマネージャーに確認を取るようにすべきだと思う。当たり前に相手がそれを知っているという前提は、大きな誤解を生むことになる可能性が高い。
他の例示として。
システムの設計では入力されるデータと、最終的に出力されるデータが定義される。このデータにはそれぞれ単位があるはずだ。とある三角形の底辺の長さ（cm）と高さ（cm）の2つを入力として受け取り、三角形の面積（cm^2）を出力するシステムというように。
設計書では入出力のデータについても記載することになる。その際、それぞれのデータの持つ意味や単位について、誤解が生まれないように明確にすることが求められる。明確化されていなかった場合、表記揺れによって一つのデータに複数の呼び名が存在するという後々になって地獄を見る設計書が誕生する。
ブログの記事をこれまでたくさん書いてきました。
分かりやすい文章が書けているだろうかという悩みは尽きない。ブログという媒体であるため、比喩を使ったり、体言止めであったり、……を使ったり、口語も混じっていたりとビジネス文書とは程遠い形にしている。
自分なりの色をブログには出したい。しかし読みやすい文章にしたい。それなりに頭を使って記事を書いているつもりだが、皆さんに自分の伝えたいものの全てが伝わっているか自信はない。
とりあえず今後とも精進していくので、お付き合い願いたい。
