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

时间:2020-03-06 14:38:21  来源:igfitidea点击:

我正在为我正在研究的项目在服务器端安装软件方面寻找好的模板。

客户端非常简单。服务器端安装有些棘手。它由几部分组成(服务,数据库连接,依赖项,需要解除阻塞的端口等)。在最近的测试中,发现了一些未记录的碎片。现在,我需要为我们的灾难恢复计划和安装方法创建安装文档,而不必测试"完整"系统。

我真的很想建议我在哪里可以得到模板或者此类文档的一个很好的例子。我希望它是操作员可以在恢复过程中阅读并理解的内容。

[编辑]
我们当前的文档主要来自管理员在异地测试中遇到的问题。编写新代码时,我想确保提前编写文档。我一直在收集VMWare映像以开始测试,但一直在寻找一些好的示例。这是Windows Server商店(2000年和2003年)。 Word模板会很棒,但是如果我能看到好的文档,我可以创建模板。关于应该测试什么的任何建议也将是很好的。

[第二次编辑]
我从发布的答案中得到了几个好主意。更改Google搜索后,我想到了一些不错的起点。它们并不完美,但它们是一个良好的开端。

Microsoft Exchange http://technet.microsoft.com/zh-CN/library/bb125074(EXCHG.65).aspx
iPhone http://manuals.info.apple.com/zh_CN/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html
http://cregan.wordpress.com/2006/06/22/exchange-2003-step-by-step-installation-instructions/

http://technet.microsoft.com/zh-CN/magazine/cc160942.aspx

涵盖设计阶段的规划http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

[2008年10月29日编辑]
这是我一直在寻找的类型样本。它没有太多的垃圾,但是似乎可以充分解释其原因以及如何http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile

解决方案

我们用于创建灾难恢复文档的最完整的方法包括完成一个(或者两个)完整的安装周期,并记录整个过程中的每个步骤。

我意识到,如果没有用于创建文档的测试(或者替换)系统,这可能会有些困难,但是值得游说至少运行一次。

(我建议两次,第二次由不参与项目的人员完成,这是我们为将来的管理员测试文档的方式,他们可能对此流程没有经验。)

上面的一个副作用是文档在我不得不做的最后最后变得相当大,我相信我们数据库服务器的完整安装手册为30多页。

取决于管理员,自动化是有帮助的。我曾经有Windows管理员,他们希望使用Word文档并提供逐步说明,而其他管理员则需要脚本。

但是,有些有用的东西可能会包括在内

  • 验证他们是否工作
  • 新文件的版本在哪里(就我而言,他们对两者进行了区分,这有助于减少有关特定于生产的值的错误)
  • 对于Web场部署,拥有一份有关如何将服务器拉入和拉出池的协调文档可能会有所帮助。

应该测试什么?好吧,对于网站而言,"我们可以进入该页面吗?"包括一个URL作为起点,并让管理员点击进入特定位置。管理员不必经历整个质量检查周期,只需确认我们要部署的内容确实是已部署的内容即可。

其他想法
另外,我们(我的上一个工作团队)对部署进行了质量检查。作为质量检查人员,他对细节不敏感,在部署质量检查时,我们能够获得关于发生问题的反馈。

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

模板?只需创建具有用于数据字段的部分,例如DEV,QA和PROD的URL。当我们写出说明时,我们可以参考这些说明。只需弄清楚正在部署什么。