はてなブックマーク

こんにちは、tacoms EMのかがわ(@shinpr_p)です。 皆さんはプロダクトに関するドキュメントを書いていますか？ 私はここ数年はプロダクトの特に仕様に関するドキュメンテーションには否定派のスタンスを取っていました。 理由は、ドキュメントは不足よりも誤った情報が記載されていることによる負の影響が大きいと考えているため、です。 企画段階など開発に着手する前にドキュメントを新規作成することは比較的容易です。ですが、作成された瞬間からドキュメントは腐っていきます。これを常に最新の状態に維持するためには一定以上の運用コストを払わなくてはいけません。 一言で運用といっても、さまざまな経路からプロダクトに対する改善要望は発生しますし、不具合や障害起因で仕様変更を余儀なくされることもあります。これらに都度追従し、ドキュメントを更新し続けるためには涙ぐましい努力が必要です。 私は地道にコツコツ努