代码之家 › 专栏 › 技术社区 › Brad Bruce

我在哪里可以找到关于服务器端软件安装的文档模板?[关闭]

documentation installation

0

Brad Bruce · 技术社区 · 17 年前

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

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

我真的很想得到一个建议,告诉我在哪里可以获得模板或这样一个文档的一个很好的例子。我希望它是一个操作员在恢复的高峰期可以阅读和理解的东西。

[编辑] 我们目前的文档主要来自我们的管理员在非现场测试中遇到的问题。在编写新代码时,我想确保文档是提前编写的。我一直在收集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

[2008年10月29日编辑]
这就是我要找的型号样本。它并没有很多垃圾,但似乎已经足够解释了为什么以及如何 http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile

3 回复 | 直到 10 年前

1

2

Dominic Eidson 17 年前

我们为创建灾难恢复文档而提出的最完整的方法包括完成一个(或两个)完整的安装周期,并记录沿途的每个步骤。

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

(我建议两次,第二次由与项目无关的人完成——这就是你为未来的管理员测试文档的方式,他们可能对这个过程没有那么多经验。)

上述情况的一个副作用是,您的文档变得相当大——上次我不得不这样做,我相信我们数据库服务器的完整安装手册有30多页。

2

0

oglester 17 年前

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

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

另一件有用的事情是在部署之前与管理员坐下来。仔细阅读说明书,确保他们和你一样理解。

模板? 只需创建包含数据字段的部分,如DEV、QA和PROD的URL。当你写指令时,你可以参考这些。只需明确所部署的内容。

3

0

oglester 17 年前

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

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

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