ドキュメント作成の有用性

なんと今年に入って初の投稿となってしまいました。 仕事もプライベートも忙しかったとはいえなかなかの体たらく。反省しなければ。

さて、最近のMasakiは何をしてるかといいますと、もっぱらドキュメント作りに勤しんでいます。

今までも Markdown を使ったドキュメント作成は力を入れていたんですが、 絵や図を駆使したプレゼン資料みたいなのはあんまりやったことがなかったんですよね。

で、やったことがないことはいつまで経ってもうまくならないってことで、 案件の資料として渡されるパワポとかを参考に見よう見まねで作ってみたりするんですけど、 なんとも ダサい。

ツールの使い方くらいは調べればわかるけど、それをどう活用するのかがイマイチわからんって状態でした。

画面設計を頼まれたので

最近は設計段階からお仕事を任される機会も増えてきてたんですけど、 ちょうどよく画面設計の依頼が来たのを機にFigmaを覚えてみました。

画面設計はフロントエンドエンジニアだけあって案件でも見る機会が多く、 完成形が頭でイメージしやすかったので意外とすんなり覚えられました。 あと追加でいくつか画面作ったらおおよそ実務で困らない程度には習得できそうな感じ。

画面設計書って、例えばSIerとかだとExcelやパワポを使ってるところも多いと思いますが、 Figma を使ってみた感想としては、Officeツールよりもずっとパワフルで簡単に画面イメージが作れるし、 状態遷移や画面遷移なども設定できるので実装の認識合わせもしやすいと思うのでデザインツールを使うのはおすすめです。

逆にWeb系だとこの手のタスクはデザイナーさんがやってるところもあると思います。 ですが世の中にはまだまだデザイナー不在の案件も多いですし、 エンジニアが雰囲気だけでもデザインできるようになることで、 単なる実装者から一つ上の段階を任せてもらえるようになるので収入UPの足がかりにも繋がる実感があります。

お仕事をそろそろ人に渡したいので

今までもなるべくドキュメントは残すようにしてきたんですが、 それなりに歴史を積んできたシステムの保守とかやってるとだんだんドキュメントも古くなってくる。

ちょっと前の自分が書いたドキュメントも、改めて見返すと情報が全然足りてないし無駄な文章が多い。 もしいま僕がいなくなったとして、さすがに後任にこれだけの資料で引き継ぐのは酷。

チーム開発をするにしても、いくら僕が天才であったとしても他の人に手伝ってもらうためには共有するための資料が必要。 ドキュメント作成スキルが高ければ高いほど、天才の脳みそを余すことなく共有することができるわけです。

ってことで、頑張ってドキュメント作成スキル磨きます。

記事書くの久しぶりすぎてオチなかった。