Installation 在哪里可以找到有关软件服务器端安装的文档模板?

Installation 在哪里可以找到有关软件服务器端安装的文档模板?,installation,documentation,Installation,Documentation,我正在寻找一个好的服务器端安装软件的项目,我的工作模板 客户端非常直截了当。服务器端安装有点棘手。它由几个部分组成(服务、数据库连接、依赖项、需要解锁的端口等)。在最近的一次测试中,发现了几块未经记录的碎片。现在,我需要为我们的灾难恢复计划创建安装文档,以及在不必测试“完整”系统的情况下测试安装的方法 我真的想要一个建议,我可以在哪里得到一个模板或这样一个文档的一个非常好的例子。我希望它是操作员在经济复苏的热度下能够阅读和理解的东西 [编辑] 我们当前的文档主要来自我们的管理员在非现场测试期间

我正在寻找一个好的服务器端安装软件的项目,我的工作模板

客户端非常直截了当。服务器端安装有点棘手。它由几个部分组成(服务、数据库连接、依赖项、需要解锁的端口等)。在最近的一次测试中,发现了几块未经记录的碎片。现在,我需要为我们的灾难恢复计划创建安装文档,以及在不必测试“完整”系统的情况下测试安装的方法

我真的想要一个建议,我可以在哪里得到一个模板或这样一个文档的一个非常好的例子。我希望它是操作员在经济复苏的热度下能够阅读和理解的东西


[编辑] 我们当前的文档主要来自我们的管理员在非现场测试期间遇到的问题。在编写新代码时,我希望确保提前编写文档。我一直在收集VMWare映像以开始测试,但一直在寻找一些好的示例。这是一家Windows服务器商店(2000年和2003年)。Word模板会很棒,但是如果我能看到好的文档,我可以创建模板。任何关于测试内容的建议都会很好


[第二次编辑] 我从贴出的答案中得到了一些好主意。在改变了我的谷歌搜索之后,我想出了一些好的出发点。它们并不完美,但它们是一个良好的开端

Microsoft Exchange- iPhone-

涵盖设计阶段的规划以及-


[编辑10/29/2008]

这是我要找的类型样本。它并没有太多垃圾,但似乎已经足够解释了为什么以及如何创建灾难恢复文档的最完整的方法,包括经历一个完整的安装周期(或两个),并记录过程中的每个步骤

我意识到,如果您没有用于创建文档的测试(或替换)系统,那么这可能会有点困难,但至少在这个周期中运行一次是值得游说的

(我推荐两次,第二次是由与项目无关的人完成的-这是您为未来的管理员测试文档的方式,他们可能对该过程没有经验。)


上面提到的一个副作用是,您的文档变得相当大—上次我不得不这么做时,我相信为我们的数据库服务器完成的安装手册有30多页。

根据管理员的不同,自动化是有帮助的。我曾经有过windows管理员想要一个带有分步说明的Word文档,还有其他管理员想要一个脚本

但是,有些有用的东西可以包括在内,可能作为部分

  • 数据库更改
    • 要运行的脚本
    • 核实他们是否有效
  • 配置更改
    • 有什么变化
    • 其中是新文件的一个版本(在我的例子中,它们不同于这两个版本,这有助于减少与生产特定值相关的错误)
  • 一般核查
    • 从用户角度看,应该有什么不同(功能更改)
  • 对于web场部署,有一个关于服务器需要如何拉入和拉出池的协调文档可能会有所帮助

应该测试什么?对于网站,“你能进入页面吗?”包括一个URL作为起点,并让管理员点击到某个点。管理员不必经历整个QA周期,只需确认您打算部署的内容确实是部署的内容


其他想法 此外,我们(我上一份工作的团队)对部署进行了QA测试。作为一名QA人员,他对细节并不熟悉,当他部署到QA时,我们能够得到错误的反馈

另一件有用的事情是在部署之前与管理员坐下来讨论。仔细阅读说明,确保他们理解的方式与你相同



模板?只需制作包含数据字段的部分,例如开发人员、QA和产品的URL。编写说明时,您可以参考这些字段。只需明确部署的内容。

在这种情况下,大小并不重要。这一切都是在记忆棒上进行的,管理员会一直保存在记忆棒上。这些都是很好的建议。在脚本部分,我同意你的看法。我甚至可能需要编写一个安装应用程序来执行安装并测试每个步骤。根据我们的指导,“有些问题仍然是离题的,即使它们属于上面列出的类别之一:……要求我们推荐或查找书籍、工具、软件库、教程或其他非现场资源的问题是离题的……”