代码存储库中如何记录软件架构的治理结构？

本文共计1058个文字，预计阅读时间需要5分钟。

Markdown是一种轻量级的标记语言，用于创建格式化的文档。它比HTML更简单，无需专业编辑器即可进行文档管理。Git配置工具也支持Markdown格式。在Git环境中，Markdown通常用于编写文档。

Markdown 是一种标准的简单语法，用于创建具有专业外观的文档。它比 HTML 更简单，无需专门的编写编辑器即可进行管理。Git配置管理工具也支持markdown格式。在 Git 环境中，markdown 一般用于项目的简单介绍和构建说明。（自述文件）。本文介绍了如何将 Markdown 格式与模板一起用于架构文档。

带有 Markdown 的架构文档

与代码一起管理软件的架构设计和设计决策将为项目提供极大的便利。当我们的设计与代码一起保存在配置管理环境中时，我们可以一起进行设计变更和代码变更。当新工程师开始项目并将代码拉到他的计算机上时，他有机会看到系统的架构。

准备 Markdown 文档 IDE

您可以使用 Visual Studio Code 和类似的 IDE 与您的代码一起准备 markdown 文档。（市场上有 markdown 编辑器，但使用 IDE 来做会更实用）。您可以在 Visual Studio Code 中使用“Markdown Preview Enhanced”插件。使用这个插件，你可以在 VS Code (Preview) 中直观地看到 markdown 文档。您还可以使用相同的工具生成 HTML、World 或 PDF 文档。