読者です 読者をやめる 読者になる 読者になる

$shibayu36->blog;

株式会社はてなでエンジニアをしています。プログラミングや読書のことなどについて書いています。

エンジニア立ち居振舞い: 分かりやすく依頼する・説明する

tech

 お題「エンジニア立ち居振舞い」というお題を id:hitode909 くんが作っていたので書いてみる。

 コードを書く以外にいろいろとしているのだけど、その中の一つとして「分かりやすく依頼する・説明する」ということに時間を割いているので紹介。


 エンジニアとしてものづくりをしていると、いろんな人とのコミュニケーションが発生する。例えば、デザイナにデザインを依頼する、ディレクターに状況を報告する、他エンジニアにレビューを依頼する、他エンジニアにコードの意図を説明するなど。

 この時、相手が空気を読まなくとも文章の意図やお願いしたいことをすぐに理解できるように、できる限り分かりやすく文章を書くように心がけている。自分のことだけを考えていると、自分の時間がもったいなくて、さっと雑に書いてしまいがちだ。しかし、結局成果というのはチームで作るもので、チーム全体で一番時間を使わないようにしたい。そう考えると、一番背景を理解できている自分が、その背景を類推しなくても相手が分かるように説明し、相手の時間を無駄に奪わないようにするのが一番早い。

 もちろん、コミュニケーションは文章だけでなくても良いので、話すほうが早いと思ったら直接話しに行く。しかし、そのときも相手の時間を無駄に使わないように、何を話したいのかまず自分で文章にまとめてから話に行くようにしている。 話しかけるときはエンジニア立ち居振舞いシリーズ - hakobe-blog ♨にかかれている内容も気をつけたい。


 では、どうすれば分かりやすい文章を書けるようになるのか。

 方法の1つは自分の中でフォーマットを決めることだ。例えば

  • 作業を依頼するときは、なぜやりたいか(Why)、何をやってほしいか(What)、いつまでにやってほしいか(When)を必ず書く
  • レビュー依頼するときは、なぜこのPullRequestを送ったのか、このPullRequestで何をやったのか、逆に何をやらなかったのか(後回しにしたのか)、不安なところはどこなのかを伝える

など。

 さらに、とにかく文章を書きまくるという方法もある。僕はあまり文章がうまくないので、文章力をあげようととにかくブログを書くということをしている。ブログを書くと、背景知識のない人にも分かるように、相手のことをイメージして書くようになる。そのため、徐々に徐々にではあるが、相手に伝わりやすい文章を書けるようになってくる。これを続けていくと、コード中のコメントや、ドキュメントも分かりやすく書けるようになってくるのでおすすめ。


 以上、僕のコードを書くこと以外のエンジニア立ち振舞でした。