エンジニアが書くべきメモとは

エンジニアが書くべきメモとは

仕事をしていると、みんなメモを録り書き残します。みんな何を書いているか気になることはありませんか？

どちらかというと、会議や話の中の重要なことや自分に依頼された仕事を書くことが多いのではないでしょうか？

それはもちろん大事なことですが、ITエンジニアの場合もっと他にも書くことがあります。

例えば、技術的な調べ物をして調査途中の内容や結論、何かを実施する場合の手順などです。

僕はほとんどの場合、調べ物をした内容や作業していった手順を記録して残します。

なぜかというと、調べた経緯や手順を後でもう一度実施することが少なくないからです。

一度実施したから次も覚えているかというとそうでもないことも結構多いものです。

特に調べ物をしながら試行錯誤しながら実現した手順などはそうです。

次回同じようなことが必要になったときに、もう一度調べ直すのは非常に効率が悪いです。

そのときのために手順を残します。関連する情報があるなら、例えばURLや文書などへのリンクも併せて残します。

メモを残しておくことで、もう一度やる手間を減らしたり、頭の中で思い出しながらあやふやにやるより早く確実に実施できるのです。

まずは言葉そのものを残す

会議中や誰かの話を聞いたとき、忘れないようにとメモを録る場合、僕が大事にしているのは、その人の言葉通り書き残すことです。

その人の言葉通りというのは、自分の解釈によって話をまとめたり、違う言葉に置き換えないということ。

その人が言った言葉の解釈が聞いたその瞬間と後で思い返したときで印象や理解が異なる場合があります。

ややもすると違う理解で頭にすり込まれてしまうこともあります。

そうしたことを防ぐためにも、僕は極力「その人の言葉そのもの」を残すようにしています。

その方が後で読んだときのリアル感が違います。

関連する情報も一緒に残す

大事なことはまずメモを録ることですが、メモを録るだけではそのメモを生かすことができません。

その情報を元にさらに自分なりの調べを進めたり、その結果得られた自分なりの解釈や次のステップへのアクションにつなげることが大事です。

時々見返したいなら、見返す場所に書き写しておくとか、関連する本を読んでみるとか、そういうことにつなげていくことが成長につながります。

調べた結果や手順を残す

ITエンジニアに限りませんが、何か解決したいことがあって調べ物をしたり、繰り返し実施できるように手順として確立するために試行錯誤することは少なくありません。

例えばですが、こういうことなどが手順を記録する例です。

• エクセルで自分の問題を解決する方法を探し当てた
• おすすめのエディタやフローチャートを描くツールを使ってみたら、意外と良かった、思ったより使えなかったという自分なりの判断結果
• 画像を資料に貼り付けるのに、背景除去をする方法として便利な方法を見つけた
• AWSやAzureの使い方で気をつけなければいけないことがあった

こんな時、調べた結果どうなったのか、そこをきちんと残すことが大事です。

僕は仕事柄ツールを調べることがよくありますが、このツールはどうだった、という一言コメントをよく残します。

そうしないと同じツールをまた同じような手順で調べることがあったからです。

ツールの善し悪しを選別しようとするような場合、あまり深く使い込まないので強くは印象として残らないので、また同じように調べたあげく「前に調べた気がするな」と気づくことになります。

これだと時間が無駄になります。

とはいえ、同じツールでも違う用途の場合もあるので、違う観点で調べ直すことはあります。

情報の出所も記録すると役立つ

調べているときに、そのツールのヘルプだったり、参考になる良い記事だったりに出会うことはあります。

そういったとき、参考になった情報の情報はどこにあったか、今はWebが多いのでリンク先を残します。

最初はGoogleで検索すると思いますが、検索結果からさらに調べた結果、自分が望む情報にたどり着くことも少なくありません。

そういった、重要なリンクは確実に残しておかないと、再度見つけるのに苦労することもしばしばです。

昔のGoogleなら、何ヶ月かして検索しても同じ結果が得られましたが、今は検索結果がその人の検索結果やアクセス状況でどんどん順位が入れ替わる時代です。

検索キーワードが違えば違う結果になります。

Google検索に頼らず、自分でリンクを残す習慣を持ちましょう。

情報を適時更新する

記録したメモはそのままで使えるものはいいですが、間違いに気づいたり更新が必要になった場合には更新していきます。

書いた当時は理解が深まっているので簡易なメモでも問題なく理解できるのですが、半年や1年経って読むときは当時持っていた情報が失われているので、同じメモでも内容が理解できないことがあります。

書くときに注意して書ければいいのですが、なかなかそこまで先回って書くことができなかったり、それだけ時間をかけて書くこともできないこともしばしばです。

ですから、書いてあるメモが不十分だと気づいたら、すぐに補足を入れるようにしましょう。

そういった情報の更新がまた次に使うときに役立つことになります。

すべてのメモのアップデートが必要なわけではなく、再利用したときに足りない情報を補っていけば、再利用されるメモの精度は上がっていきます。

それで十分です。