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

时间:2008-09-24 02:40:11

标签: installation documentation

我正在寻找一个关于我正在进行的项目的服务器端软件安装的好模板。

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

我真的很喜欢我可以在哪里获得模板或这样一个文档的一个非常好的例子。我希望这是一个操作员可以在恢复的过程中阅读和理解的东西。


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


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

Microsoft Exchange - http://technet.microsoft.com/en-us/library/bb125074(EXCHG.65).aspx iPhone - http://manuals.info.apple.com/en_US/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/en-us/magazine/cc160942.aspx

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


[编辑10/29/2008]
这是我正在寻找的类型样本。它没有很多垃圾,但似乎解释了为什么以及如何http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile

3 个答案:

答案 0 :(得分:2)

我们为创建DR文档而提出的最完整的方法,包括完成整个周期(或两个)的安装,并记录整个过程中的每个步骤。

如果您没有用于创建文档的测试(或替换)系统,我意识到这可能有点困难 - 但是至少要花一次时间来讨论这个循环。

(我建议两次,第二次是由没有参与项目的人完成的 - 这是你为将来的管理员测试文档的方式,他们可能不熟悉这个过程。)

上述的一个副作用是你的文档变得相当大 - 最后我必须这样做,我相信我们的数据库服务器的完整安装手册是30多页。

答案 1 :(得分:0)

根据管理员的不同,自动化很有帮助。我有Windows管理员需要一个Word文档,一步一步的说明和其他需要脚本的管理员。

然而,一些有用的东西要包括在内,可能是作为部分

  • 数据库更改
    • 要运行的脚本
    • 验证他们是否有效
  • 配置更改
    • 有什么变化
    • 其中是新文件的版本(在我的情况下,他们将两者分开,这有助于减少有关特定于生产的值的错误)
  • 一般验证
    • 与用户角度(功能更改)应该有什么不同
  • 对于Web场部署,可能有助于获得有关如何将服务器拉入和拉出池的协调文档。

答案 2 :(得分:0)

应该测试什么?嗯,就网站而言,“你能进入这个页面吗?”包含一个URL作为起点,让管理员点击进入某一点。管理员没有必要经历整个QA周期,只是确认您要部署的内容实际上是部署的内容。


其他想法 此外,我们(我上一份工作的团队)对部署进行了QA测试。作为QA的人应该是,他对细节并不亲密,当他部署到QA时,我们能够得到有关出错的反馈。

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


模板?只需创建包含数据字段的部分,例如DEV,QA和PROD的URL。当你写出指令时,你可以参考那些。只需说明正在部署的内容。