00:08
はい、みなさんこんにちは。kkeethことくわはらです。本日もやっていきましょう。
kkeethのエンジニア雑談チャンネル。この番組では、ウェブ業界やエンジニアリング、いろんな技術についての情報を雑談形式で発信していきたいと思います。
で、今日はですね、人の振り見て我が振り直さねはなぁというようなお話をしてみようかなと思ってます。
今日は主にドキュメントの話ですね。
まあ、とある現場の、いわゆる写真的なものを見せていただいたんですけど、ここに資料があるよと言われて、ごちゃついてるんですよね。
物理的な資料ですけど、この中のどっかにあるとか言われて。
よく大学の教授とか研究室とかで、たまにすごい散らかってる派の教授と、めちゃめちゃ綺麗な教授と、たぶん2パターンあると思うんですよ。
まあ、中間層もあるかもしれないですけど、結構散らかる方は完全に散らかり倒してると思うんですよね。
けど、その人は、この辺にそれあるよって言って、確かに探ってみる。その教授が探ると、確かに出てくるんですけど、僕らはわからんみたいな。
個人に最適化されてしまった散らかり方とかをするんですけど、そういうような近しい現場の写真を昨日ちょっと見て、ちょっと思うところがあったなっていう話を今日はしてみたいかなと思ってます。
ドキュメントの話ですけど、どちらかというとノーションの話という風に思っていたほうがいいかもしれないですね。
で、その散らかってる現場の写真を見て思って、最初は本当に失礼ながら、正直笑ってしまったんですよね。
まあ、よくある話だし、デジタルが進んできたらもう令和だぞと思いながらも、そういう散らかったというか、整理がされてないようにどう客観的に見ても見えてるなみたいな現場の写真を見て、正直僕は最初は笑ってしまったんですね。
で、笑ってしまったんですけど、言うて自分の自宅でも散らかってる部分はやはりあるし、自分の身の回りですら綺麗になってないのに外の人を笑うのはちょっと失礼だなって思いつつ、そこで気づいたというか感じているのは、弊社はノーションを使ってて、昔は全然社内ポータルとか全然違うものを使ってたんですけど、
途中でコンフルに1回移ったり、ドロップボックスペーパーに移ったりとかしたことあるんですけど、最終的に今ポータル的なものをノーションに置き換えていて、デフォルトはノーションを使ってますし、社内情報はほぼ全部ノーションになってます。
一部案件とかでコンフレンス使ったりとか、チケットはジラーを使ったり、バックログを使ったりしてる案件もあったり、アトラシアに使うこともありますけど、ノーションを使ってるんですが、ノーションって使い勝手がものすごく素晴らしいし、多機能プラス高機能というところで、これだけ伸びてきた理由はわかります。
ノーションってすごく無邪気にページが作られて、無邪気にデータベースも作れて、みんなが勝手にどんどん生やしていくような環境だと思います。どの会社さんもだいたいそうだと思っていて、それの整理をしないと同じことが起きるなと気づいてしまいました。
冒頭の現場の会社さん、散らかってるよねって言うけど、笑ってるけど我々のノーションを見たら同じことを言われるし、同じような状況じゃないっていうのは本当そうで。
03:06
そのドキュメントが散らかっていると何が良くないかというと、まっさきに検索性が悪いですよね。そもそもノーションの検索のクオリティが低いみたいな声はたくさん聞きますし、私も同じことを感じてます。
で、この度AIが入ってきて、AIに質問すればこの辺から見つけてくれるよみたいなところはあるとはもちろん思います。それで解決するじゃんっていう話はゼロではないんですけど、
とはいえ、AIも膨大な情報の量の中から検索をしてきて、これじゃないって判断をしてくれるんですけど、
似通った情報だったり、似たような探したいドキュメントソースっていうのがラベル付けていくと基本的には被るっていうものがあると、結果的には出してくる情報の揺れって絶対起きると思うし、近いんだけど違うんだよなっていう話は発生し得ると思うんですよね。
すなわち整理をしてないと未来の自分もそうですし、チームメイトの検索の悪さとか人の時間を奪う原因を作ってしまっていることにはほかならないと思うので、
ちゃんと片付けをしようっていうのは、そういう物理を見て自分たちの中の何かを見直さなきゃいけないっていうので、今回Notionを見て、そういえばそうだ、うちもかなりひどいなみたいなのがあったりします。
例えば、とあるプロジェクトをやるとして、うちは大体プロジェクトを立ち上げるときはプロジェクト用のドキュメントのテンプレートがあるんですね。
そのテンプレートの中に議事録のものがあったり、キーリザルズみたいな項目があったり、あとは仕様とか、確定した情報はここを見てくださいみたいなデータベースがあったりっていうようなテンプレートを作ってあるんですね。
それはよろしい。なんですけど、プロジェクトの情報を何か調べたいときに真っ先に行くとしたらどこかってさ、そのプロジェクトのダッシュボード的なところに行くんですけど、そこの情報がまとまってないと議事録のどっかにあるとかって言われたりするんですよ。
議事録ってものすごい雑音が多い情報じゃないですか、ドキュメントだと思うんですよね。
その中から探せって言われるのは、いわゆる片付いてない情報の中から情報見つけてこいって言われるのが他ならなくて、いや、そりゃつらいだろみたいな話があるわけですよ。
なので、どんどんツールが進化してって便利になったところへとは進化しないので、他の人のためにもやっぱり整理をするとか、いろんなものをまとめるとかしなきゃいけないと思ってます。
この話っていわゆる技術的不採と結構リンクする感覚が僕にはあって、プロダクトもそうですし技術もそうですけど、そういうものって世に出た瞬間からいわゆる不採が始まるんですよね。
古くなっていくってことですね。リリースしたからそれが始まるので、いかにメンテナンスを継続的にしていくかっていうのはすごく重要にはなってきます。
それで時間が経ってきて、新しい技術とか新しいトレンドが生まれてきて、もうこの技術は使われませんって淘汰されたり、廃れていくものはもちろんあると思います。
それはそれで仕方なくて、同じことはドキュメントにも起きるわけですよね。
ドキュメントこそ鮮度が命だと思ってます。その鮮度を保つためにちゃんと情報のアップデートをしましょうっていうのはすごく大事で、
僕の持論ですけど、極論言うと、ドキュメントとかその議事録もそうですけど、ちゃんとまとまっているものがあって、雑多なものじゃなくここを見れば今回の求めたい情報は全部ここに書いてあるっていうものがあるんだったら、
06:11
今まで書いた僕は議事録はむしろ捨てされたい人なんですよ。検索の邪魔になるし雑音になるので、むしろまとまったのであればその雑多な枝派のものしか書いてない議事録は僕は決死対派なんですよ。
多分怒られるし、いろんなことを仮面にするとバックアップとして残しておく方が良いでしょうっていうのはよく言われると思うので、消すことは多分現実的ではないんですけど、私はそれぐらいやりたいんですよね。
その時間を奪うのがとにかく嫌いなので、ちゃんとそのまとまりを作るという、整理をするという時間とかタイミングはしっかり作らなきゃなって思ったりします。
どこまでそれを毎日毎日、いわゆるリファクタリングしながらドキュメントを書くみたいな感覚ですけど、どこまでリファクタリングを毎日したところで、やはり時間が経って振り返ってみると、
使われなくなったドキュメントだったり、これはもう古くなってもう仕様変わってしまったので違うねみたいな話があったり、信頼性がなくなったとか、そもそももう価値がなくなったドキュメントって発生しうるんですよね。
なので定期的にもうちゃんとプロジェクト、まだ走ってる途中であろうと、ドキュメントの見直しをしたり、情報の整理をするというのはすごく大事で、これはソースコードだけじゃなくて、日頃からドキュメントでもやらないと、
実際技術の方とかプロジェクトの開発の方でもできないんじゃないですかね。たまにリポジトリ見ると、マージされたけど削除されてないブランチが大量に残ってますみたいなプロジェクトもあったり、
最初に書いたウィキが結局もう今使ってないし誰も見てないウィキになりましたとかもあったり、リードミーそのものも情報が足らなかったりとか、簡素だったり逆に使われなくなったコマンドが未だに書かれてたりなどなどたくさんあるんですよね。
でもチームで開発するとなると誰かがそこを見に行く可能性はあるし、新しくメンバー入った時のオンボーディングで情報が散らかってたりすると教えるの大変だよねとか、その人が入った時初めて整理をするとか、それじゃ遅いわけですよね。
仲の人が定期的にちゃんとドキュメントを見直すっていうのは大事だし、僕はたまに言いますけど、ドキュメント専門の人とかドキュメントエンジニアみたいなのを普通に雇って、ちゃんとその人が各プロジェクトをガーッとあんぎゃして整理をするっていうポジションって多分ニーズあると思うんですよね。
ただ価値を生み出すからすごく難しいんですけど、やってもらった仲の人からすると絶対感謝はされると思って、なんかそういう平和な世界ないのかなと思ったりします。
そういう人がいると客観的に外からドキュメントとかプロジェクトを見てくれるので、改めて整理したり、みんなが当たり前に思っている暗黙地というのを言語化したりとかできたりするので、本当に整理と整備が進むんですよね。
今はプロジェクトの話をしたけど、これは企業のコーポレートのページとかとも一緒ですね。ポータルサイトとかも同じことです。
これは基本的には総務の方々とかやられてると思うんですけど、バックオフィスの人にも限界はあるし、技術のことはわからなかったり、やっぱり専門職のドキュメントは専門家の方にやっていただくにはならないので、
そういういわゆるクリエイター職とか専門職の人たちも自分たちの持っているドキュメントの更新とか見直し、何なら削除はしないにしてもアーカイブするとかっていうのは常にした方がいいなというのを、
09:11
昨日はとある現場さんの写真を見て、自分たちもやらないけんのかっていうのをちょっと思ったっていう、そういう次第ですね。
参考になれば幸いですし、こういう日頃からできてる習慣とか日常が他の現場とか開発のところでも生きるし、その逆も然るですね。
開発でできてるんだったら本来ドキュメントでもできて然るべきだと思ってますし、
ドキュメントこそ英知を固めるものではあって、未来の自分もそうですし、さっきのチームメイトもそうですし、会社の資産としてもしっかり整備をしていくのはすごく大事だと思っているので、
これはですね、ぶっちゃけブーメランであるし、自分の次回の意味を込めて今喋ってるんですけど、
しっかりやっていけたらなというふうなお話でした。
はい、今回はこんなところで終わっていきたいと思います。
いつも聞いてくださり本当にありがとうございます。
ではまた次回の主力でお会いしましょう。
バイバイ。
