ドキュメントは非同期の愛
見出し画像

ドキュメントは非同期の愛

平野太一

人数が増えればそれだけ、同じところで迷う人がふえる。だからこそ、“車輪の再発明” をしないように、社内ドキュメントとして残していくことが大事になる。

昨日アップデートされた、「SmartHR Design System」の運用理念にあった以下の言葉がすごくいいなと思ったので、少し考えたことを。

情報をオープンにすることは、私たちの間で無用な齟齬・苦労を避けるだけでなく、社会にも“車輪の再発明”を減らすなど、良い影響をもたらすと考えています。SmartHRがリリース当初からe-Gov APIライブラリ「kiji」をオープンソースにしてきたように、知識や情報を共有して、社会に貢献します。

情報格差を生まないことが、組織や仕組みをフラットにし、世の中をより良くすると信じています。

SmartHR Design System 運用理念


自分が知りたいことは、
きっと誰かが先に考えている

何かわからないところが出てきたとき。社内の他チームに聞かなければならないとき。「すでに誰か書いていないかな?」と考えるようにしている。

その理由は、インターネットで自分が知りたいことを検索してみると、自分の考えたことはすでにたくさんの人たちが答えを出してくれていたという経験がめちゃくちゃ多かったから。

もちろん、まだ誰も考えたことがないような疑問もあるかもしれない。けれど、ほとんどのことはだいたい出てくる。それが前提にあるから、すぐ聞く人に対して、その前に少し調べればいいのにな、と思うことがある。

「これってどういうことですか?」と聞く前に、ひと呼吸置いて、「すでにやっていないかな?」「どんな判断をしたのかな?」と調べてみる。そして、その形跡を元に聞いてみる。そのひと手間を大事にしたいと思う。

自分が社内の誰かに聞く前に心がけていることは、次の3つ。

  • 社内のSlackでキーワード検索してみる

  • 社内のWikiでキーワード検索してみる

  • 知りたいことを箇条書きで書き出してみる

常にできているわけではないけど、門外漢の分野こそ、すでに誰かがまとめてくれていないか、頭出しをしてくれていないか、調べるように心がけている。


誰かが知りたいときに、
すぐ探せるように

逆に、ドキュメントをつくる側になったときは、誰かが調べたときに検索で引っかかるように、タイトルや冒頭文にキーワードをいくつか入れておくのも、ドキュメント作成において大事なことだと思う。

あとは、探すときに見つけやすいように、調べる前に見つけてもらえるように仕込んでおくこと。

例えば、Slackチャンネルで大事な情報はピン留めしたり、ブックマークに追加したり。他にも、特定のキーワードを入力したときにBotでその質問に答えるURLを唱えるZapierをつくるということもできそう(※やりすぎは禁物)。

Slackのブックマーク機能。チャンネルごとにブックマークを設定できる

そして、つくったドキュメントは定期的に見直しをして、統合・アーカイブする。都度ドキュメントを作成して情報が散らばっている状態だと、確認・追記・検索コストが膨大になってしまう。

基本は統合・取捨選択でいいが、それができない場合は、相互にリンクを貼り付けるなどして、情報をどちらからでも追えることが大事だと思う。


ドキュメントは非同期の愛情

マドベの片山さんが、過去に「ドキュメントは非同期の愛情」であるツイートしていて、書き残しておくことの重要性をまっすぐに言い当てている。

書き残しておくことが、いつか誰かを助けることにつながるかもしれない。そんなことを頭の片隅に置きながら、最近はドキュメントを書いている。

この記事が気に入ったら、サポートをしてみませんか?
気軽にクリエイターの支援と、記事のオススメができます!
平野太一

Twitter(@yriica)もぜひフォローしてください!読んでよかった本や記事、おすすめツール、noteのお知らせをよくツイートしています。 https://twitter.com/yriica

最近のおすすめ本は「はみだしの人類学」です!
平野太一
noteディレクター / 自分のnoteでは、ジャンル問わず書いています。UXライティング、タスク管理、おすすめツール(Notion, Zapier)の活用法、読んでよかったコンテンツ、買ってよかったものなど。