ドキュメント構築が苦手な人は仕事効率が悪いという話

Posted on 2022/01/18 by 弓削田公司
#ドキュメント#アウトプット
ブログを毎日書いて10年近くになる、ユゲタです。 毎朝、朝ドラを見ながらブログを書いているんですが、よく人から、「毎日よくネタが尽きないね」と言われますが、ネタはちゃんとiPhoneのネタ帳にびっくりするぐらいの量を書き込んでいるんですよ。 ていうか、毎日何かしら気になったこと、ブログネタになることは、ひとことメモをするようにしているだけなんですけどね。 あとで見返した時に、「なんじゃこりゃ」というような一言メモもあったりするので、できるだけ、ブログにつながるように、その時のどういう状況、心境で書いたメモか、最終的に何が言いたいのか、調査すべき点、思考すべき点なども同時にメモることで、ブログ執筆のスピードや熱量がまるで変わってきます。 こういうメモ術も自分ならではのモノを、似たような活動をしている人は何かしらみなさん行っていると思いますが、あくまでユゲタの場合はこんな感じです。 そして、そんなメモ術の事を考えていると、 以前に知り合った優秀なエンジニアという人が、ドキュメントを書くのが苦手だという事を言っていたことを思い出しました。

優秀なエンジニアは優秀な社員ではない

会社において、優秀なエンジニアというと、高い技術力を身に着けていて、開発効率が極めて高く、成果を挙げることができるスーパーマンのような人の事を言いますが、 ユゲタの知っている限り、会社のCTOクラスの人で、ドキュメント作成が苦手という人は、数多くいます。 その人達が組織運営で行っているのは、ドキュメントが得意だという部下に、書物を任せているのだそうです。 まあ、組織として、それでうまく成り立っているのであれば、いいのですが、果たしてドキュメントが苦手ってそれでいいのでしょうか? 各有、ユゲタも、その昔CTOとして威張っていた時期には、ドキュメントが本当に苦手で、その苦手意識から克服を目指してブログを書き始めたという経緯もありますが、当時ドキュメンテーション能力が高ければ、もっと違った開発人生だったのかもしれません。 そして、開発組織のトップたるもの、ドキュメントを書くのが仕事というぐらいに考えないといけないのだということも、数多くの開発会社を見てきて、改めて認識することができました。 逆に、キツい言い方をすると、ドキュメントが書けない社会人は、消して優秀とは言えないということと、ドキュメントが書けないエンジニアには、とんでもない落とし穴があるという事に気が付きました。

ドキュメントが書けないエンジニア

ドキュメント、ドキュメント・・・って何度も言いますが、何故そこまで重要なのかと言うと、 開発を行った成果物に対して、ドキュメントが無いというのは、使い方がわからない家電製品に説明書がついていない状態であると考えましょう。 そうです、何をどう操作すればいいか、トラブった時にどうするか、壊れた時のサポートや、どういうメンテナンスを行うかということが一切明記されていないという状態なんですね。 GithubのREADME.mdに、こうした事を意識して欠けているエンジニアとそうでないエンジニアは、READMEドキュメントを見れば大体スキルレベルが明確になります。 そして、ドキュメントというのは、仕事においては、唯一正確に相手に情報を伝える手段であると考えましょう。 もちろん、口で伝達するという、スペシャルOJT方式がありますが、これは、ドキュメントを作るのをサボって、単に口で言って、「一回言ったことは覚えておけよ」という相手をボイスレコーダー代わりにしているだけで、 その後、他の新入社員などが入社した場合、ビジネスの不毛なくだらない伝言ゲームが開始されていくという自体になります。 もちろん、話すニュアンスや、単語のチョイスなど、聞いたまんまを伝えることがほぼ皆無であることは、伝言ゲームをやったことがある人は誰もがわかるかと思いますが、 これを回避できる唯一の方法が、ドキュメントなんですね。 もちろん、動画に撮っておいて、それを再生するという手もありますが、これはドキュメントと同じクオリティにできればそれでもいいかもしれませんが、 ドキュメントが作れない人は、動画も作れません。 社会人としてはこういうドキュメントが書けないということに、大きなデメリットを感じなければ、組織として大きなしっぺ返しを食らってしまうことになるでしょうね。

企業ドキュメントに必要最低限必要な事

ドキュメントが苦手だという人に、少しだけ参考になる情報をお伝えします。 ドキュメントって一言で言っても、書く内容や、クオリティなどは、様々なので、どういうドキュメントを書くかによって、書き方をググってみて、その構成どおりに書くだけで書類としては成り立ちます。 ・・・が、この時に抜けがちなのが、「書いた日(更新日)」と「書いた人」を明記するという事です。 これが出来ていなくて、せっかくドキュメントを揃えてある会社でも、内容についてわかりにくい時に、誰がいつかいたものなのか書かれていないため、困ってしまうというケースが多々ありました。 以降、ユゲタは、この「日付と名前」を冒頭に必ず明記する癖をつけるようにしました。 誰にも怒られない上、自分がいつ書いたかを照明できるポイントとして、ドキュメント作成時には、この癖を付けておくことをオススメします。 比較的めんどくさいと考えられがちな「ドキュメント作成業務」ですが、なれると文章作りが上手にもなる上、このスキルによって、仕事が捗る事は間違い有りません。 ないがしろにできないドキュメントに対して、今一度目を向けてみてはいかがでしょうか?
SNS
Groups
  • テクノロジー
  • ビジネス
  • 日記
  • 映画
  • マーケティング
  • 学習
Tags
  • #PHP
  • #コマンド
  • #Docker
  • #Error
  • #ライフプラン
  • #思考
  • #コミュニケーション
  • #プログラミング学習
  • #思考学習
  • #モチベーション
  • #学習ポイント
  • #Javascript
  • #AudioAPI
  • #思考法
  • #成功する秘訣
  • #Cinema
  • #マネタイズポイント
  • #Job
  • #魔法の言葉
  • #Idea
  • ...
関連記事