ドキュメンテーションについての考え方

📝

風音屋で一緒に働く仲間には、ぜひドキュメントの重要性を理解してほしいと考えています。風音屋では「6つの恩恵」を受けられるように「ドキュメンテーション」を重視しています。

１）迷路から抜け出すことができる

仕事で煮詰まったときには頭の中だけで考えようとしても上手くいかないものです。「考えたこと」「試したこと」「困っていること」などを書き出すと、客観的に状況を整理し、解決策に気付けることがあります。悩む時間を減らして仕事を前に進めるにはドキュメントが欠かせません。

２）成果物をブラッシュアップできる

風音屋では互いにフィードバックを与え合うことを推奨しています。ドキュメントという目に見える成果物があるからこそ、周りの人たちからレビューを受け、ブラッシュアップできるようになります。

３）問題解決をリードできる

風音屋ではプロジェクトの企画・構想フェーズから関わることが多いです。必然的に要件定義や設計のドキュメントを書く機会も多くなります。与えられた指示通りに作業をこなすだけなら不要ですが、問題解決をリードするときにはドキュメントは強力な武器となります。

４）情報資産をスケールできる

風音屋では1の努力で10の成果を得ることを目指しています。1つのドキュメントを10人に読んでもらうと、10人それぞれに口頭で説明する場合に比べて、生産性は10倍になります。ドキュメントは再利用可能な資産であり、ドキュメントを作ることはROIの高い投資だと考えます。

５）働く環境を整えられる

風音屋ではフルリモート、フルフレックス（コアタイムなし）という働き方を推奨しています。この働き方では、テキストでの非同期コミュニケーションによって生産性が大きく変わります。報連相やドキュメント化を徹底し、関係者と信頼を構築・維持することが不可欠です。

６）日々の改善サイクルを回せる

風音屋では自分たちの仕事についても改善サイクルを回すことを推奨しています。作業やコミュニケーションの記録（データ）を蓄積・可視化・分析するように心がけています。小さな改善を1つ1つ積み重ねて、明日という日を今日よりも良い1日にしたいと考えています。

「ドキュメンテーションに慣れていない」「自信がない」という人には、以下の推薦図書をオススメしています。ぜひ参考にしてください。

風音屋では「ドキュメントを書くことこそがデータマネジメント、データエンジニアリングの第一歩である」と考えています。「1人の頭の中」や「1回の口頭会話」といった「ローカルストレージ」に情報（データ）を閉じ込めるのではなく、他の人が後から情報（データ）にアクセスできるようにすることが重要です。