了解发行说明和文档
当你向客户部署一个新的发布版本或在你的服务器上安装新的软件时，如果你希望传达已向客户发布的内容，最常见的方式是使用发行说明。
但发行说明从何而来？ 存储发行说明有多种方法。
文档存储
存储发行说明的一种常用方式是在某些文档存储中创建文本文件或文档。 这样一来，发行说明就与其他文档一起存储。
这种方法的缺点是，发布管理工具中的发布和属于此发布的发行说明之间没有直接连接。
Wiki
客户最常用的方式是将发行说明存储在 Wiki 中。 例如：
- Atlassian 中的 Confluence
- SharePoint Wiki
- SlimWiki
- Azure DevOps 中的 Wiki
将发行说明创建为 Wiki 中的页面，通过使用超链接来创建。 可以将关系与生成、发布和项目相关联。
在代码库中
当你看到它时，发行说明严格属于你实现的功能和代码的发布。 在这种情况下，最佳选择可能是将发行说明存储为代码存储库的一部分。
团队完善好一项功能后，他们或产品所有者也会编写发行说明并将其与代码一起保存。 这样一来，发行说明就会成为实时文档，因为说明会随代码的其余部分而更改。
在工作项中
另一种选择是，将发行说明存储为工作项的一部分。 工作项可以是 Bug、任务、产品积压工作项或用户情景。
可以在工作项内创建或使用其他字段，从而将发行说明保存在工作项中。 在此字段中，键入将传达给客户的公开发布的发行说明。
使用生成和发布管道中的脚本或特定任务，可以生成发行说明并存储为项目，或将其发布到内部或外部网站。
功能文档和技术文档存在差异。 此外，主要在前期编写的产品设计文档和之后描述产品的文档（如手册或帮助文件）之间也有所不同。
在设计阶段存储有关产品的技术文档是在文档共享门户（如 SharePoint 或 Confluence）上完成的。
创建 Wiki 是存储文档的更好、更先进的方式。 Wiki 不包含文档、演示文稿或电子表格，但包含名为 Markdown 文件的文本文件。
这些 Markdown 可以引用图片、保存代码示例，并作为代码存储库的一部分。 代码存储库可以很好地处理文本文件。 可以使用本机代码工具轻松跟踪更改和历史记录。
但是，使用 Wiki 而不使用文档的最大优势是，团队中的每个人都可以访问 Wiki。 通过向所有团队成员授予正确的权限，大家可以一起处理文档，而不是在处理同一文档时相互等待。
与产品一起发布的手册或文档应被视为源代码。 当产品发生变化和添加新的功能时，文档需要更改。
可以将文档存储为代码存储库的一部分，或创建包含文档的新存储库。 在任何情况下，文档处理方式都应与源代码相同。 在生成管道中创建文档项目，并将此项目交付到发布管道。
然后，发布管道可以将文档部署到站点，或将其包括在现成的产品中。