documentation - 什么样的信息会写进好的部署文档中？

Question

我与我的同事就部署文档的组成进行了持续的争论。

每个人都同意文件是必要的。并不是每个人都能找到共同点，即应该在多大程度上详细说明这一点，尤其是大版本、错误修复和增强之间的区别。

你发现什么最适合你？

Answer 1

我发现构建一个允许一键部署的工具比完整的部署文档要好得多。

Answer 2

如果您编写文档的目的是确保以可重复的方式部署代码，那么以下是最低推荐做法：

1. 发布内容的摘要、更改内容、版本、解决方案文件的位置等。
2. 列出可能的依赖项
3. 详细部署流程
4. 安装所需的数据库更改或脚本
5. 有关如何配置应用程序的配置摘要。
6. 可以运行以验证安装是否可操作的关键功能测试。
7. 回滚过程 - 如果需要。

Answer 3

你的文档的目的是什么？从那里开始，找出满足该目标的方法。

对我们来说，我们的目标是让团队中的全新人员能够为几个不同的系统执行新的或更新的部署。我们正在操作一种简单的操作——Windows 服务、cron 作业、数据库备份、网站更新等。

在每种情况下，详细程度都基于系统以及新团队成员执行更新和新部署所需的内容。