こんにちは。サーバエンジニアの桐島です。 今回は、図(フローチャート、シーケンス図など)をチームで継続的に管理するための個人的なベストプラクティスを紹介したいと思います。 図の有用性と、継続的な管理の必要性 図って便利ですよね。 以下の様な図があると、チーム内での認識合わせを正確に素早く行うことができます。 サーバ構成図 アプリ-サーバ間処理のシーケンス図 APIプログラムの複雑なロジックのフロー図 ER図 ただ、プロジェクトのドキュメントに含まれる図がすべてメンテナンスされ、最新の仕様と図がマッチし続けているケースは少ないのではないでしょうか。 図は有用なのですが、管理し続けなければその有用性を失い、いずれ削除される運命にあります。 図の継続的管理への課題 では、図が管理されない原因は何でしょうか。 具体的なケースを幾つか挙げてみます。 再編集できないフォーマットで図が作られている ホワ