私は、プロジェクトのドキュメントはソフトウェア プロジェクトの進化の一部であり、コードと結び付けられることもあると理解しています (特に無駄のない方法論では)。そのため、リビジョン管理システム (私の場合は git など) のコードと一緒に保管することをお勧めします。
Markdown は、テキスト ドキュメントを共同で編集するために広く採用され、機能しているソリューションのようです。ただし、エンティティ関係図またはシーケンス図に関しては、どの形式/ソフトウェアを使用すればよいかわかりません。そのため、引き続き差分とマージを行うことができます。
だから私の質問は:
- コードとドキュメントを同じリポジトリに保持することは実際に良い考えですか?
- はいの場合、図にはどの形式を使用しますか?
私は現在、いくつかのテキスト UML 作図ツールを検討していますが、あなたの意見を知りたいです。前もって感謝します!