如何书写服务器文档

日期: 2014-09-23 作者:Stephen J. Bigelow翻译:陈德文 来源:TechTarget中国 英文

数据中心需要时刻做好最坏的打算,但也需要不惜代价避免其发生。良好的系统文档可以帮助组织避免严重错误。 任何数据中心都可能忽视的最大问题,就是缺乏明确详实的服务器文档。  IT专业人员知道如何安装与配置最复杂的设备,但往往不具备较强的沟通能力。

这样一来,企业依赖管理员的记忆或非正式的传递知识,造成原先可以避免的整合、升级或故障处理问题,因为管理员忘记了自己之前是怎么操作的,或者在离职后出现知识真空面。  这里有一些方法能提高你的服务器文档质量。  强大的服务器文档 创建系统或服务器文档并没有统一的标准。重点不在道路,而在于如何建议一个“地图”来展示每个系统是如何安装……

我们一直都在努力坚持原创.......请不要一声不吭,就悄悄拿走。

我原创,你原创,我们的内容世界才会更加精彩!

【所有原创内容版权均属TechTarget,欢迎大家转发分享。但未经授权,严禁任何媒体(平面媒体、网络媒体、自媒体等)以及微信公众号复制、转载、摘编或以其他方式进行使用。】

微信公众号

TechTarget微信公众号二维码

TechTarget

官方微博

TechTarget中国官方微博二维码

TechTarget中国

电子邮件地址不会被公开。 必填项已用*标注

敬请读者发表评论,本站保留删除与本文无关和不雅评论的权力。

数据中心需要时刻做好最坏的打算,但也需要不惜代价避免其发生。良好的系统文档可以帮助组织避免严重错误。

任何数据中心都可能忽视的最大问题,就是缺乏明确详实的服务器文档。 

IT专业人员知道如何安装与配置最复杂的设备,但往往不具备较强的沟通能力。这样一来,企业依赖管理员的记忆或非正式的传递知识,造成原先可以避免的整合、升级或故障处理问题,因为管理员忘记了自己之前是怎么操作的,或者在离职后出现知识真空面。 

这里有一些方法能提高你的服务器文档质量。 

强大的服务器文档


创建系统或服务器文档并没有统一的标准。重点不在道路,而在于如何建议一个“地图”来展示每个系统是如何安装、配置与集成到数据中心,以便其他IT专业人员可以理解、测试、升级与故障排插,最小化生产环境浪费的时间。

组织记录各自的服务器与系统各不相同,采用的标准和详细程度也不一样。不过还是有办法来支持这些无章的文档。

列表清单。从硬件清单开始,包括所有主要组件的列表。接下来记录软件清单,包括详细的操作系统、虚拟机管理程序、虚拟机(与其他所有操作系统)、驱动程序、应用程序(工作负载)、以及所有相关序列号授权信息。

任何系统清单工具都可以详细记录硬件、软件组件并随着时间更新。提供一个完整的、一目了然的组件列表就十分有用,这样可以很容易了解系统并规划采购。整理库存报告,并连同原始安装或恢复介质以及任何原是供应商提供的文档,如手册或安装指南。

说明文档。接下来需要记录任何有关各个系统的安装与配置,从固件选项(BIOS设置)开始。同样还需要包括文档启动脚本。命令行脚本出了名的缺乏备注,所以把它们也加入文档更方便在未来修改或排查故障。接着,部署一个版本控制系统来帮助管理员跟踪版本,这样容易发现系统是否在使用旧的或错误的脚本。

更大型的数据中心,需要记录系统如何安装上架,包括局域网地址、媒体访问控制或MAC地址,记录每个网络接口卡的端口,并且需要额外记录系统如何与网络交换机连接。将这些结合起来,所有信息能够形成网络拓扑图,能够方便IT专业人员跟踪与查看目前架构,并为基础设施提出改善建议。

利用系统管理工具自动化完成一些信息收集任务。工具经常会替换更正式的文档,因为所有的报表都在动态变化,不会过时。无论采用哪种方法,在变更发生时,需要采取方法来更新系统与相关文档。错误的文档比没有文档更糟糕。

文档放哪儿?


关于系统与服务器文档,将其保存在何处,并没有明确的要求。 

系统文档最理想的情况是接近物理系统,这样方便查看重要细节,快速访问重要详细记录,加速恢复运行时间。用其他介质保存文档,不要将其保存在系统中。文档是为了帮助排除故障,但如果出现系统故障或无法访问系统本地磁盘上所保存的文档时,就一点用都没有了。

在单独的位置合并文档也十分常见。如果你选择这样的路线,需要为手册设置一个架子,配置文件与数据中心其他细节信息也要放在附近。避免文件冗余副本——改变其中一份的内容往往很难更新到其他子副本中,从而导致错误与混乱。

保存文档的介质并没有太大的实际区别。纸打印、刻录到光盘、记录在闪存驱动器,甚至在主存储区域网络上保存电子手册与文档都是可行的:根据自身具体环境规模与复杂程度,选择可接受的媒介。系统管理很可能会产生很少的硬拷贝文档。确保一致性与整合,使每个集都容易获得。 

妥善保管服务器文档


一般情况下,伴随新服务器而来的供应商文档价值有限,系统一般是根据实际情况进行配置和部署,但这是很好的参考文档,建议保留供应商的文档作为自己文档开发的参考。

供应商文档的批量与错误已经越来越少,因为更多的产商已经转向基于WEB的文档与指南。例如,供应商可以更新他们自己的在线文档,帮助梳理错误、勘误、故障排除与解决方法。

不过,原来的文档与当前配置详细信息依旧存在可以重新利用的价值(出售给其他用户或重新分配给其他业务部门)。

为了文档方便


文档必须明确和准确——下至特定的按键,上至复杂安装过程中的鼠标点击。需要能够手动记录纤细活动信息,但还是有很高的几率跳过某些特殊步骤。

用工具记录所有操作过程,并给用户编写文档留下一步一步可查阅的关键步骤。

其中一个工具是微软的问题步骤记录器(PSR.exe),最初集成在Windows 7和Windows Server 2008 R2上,以帮助支持人员查看究竟用户桌面上发生了什么。IT管理员发现其能够记录和备注每次鼠标点击,接着将其保存为压缩的MHTML报告,这远比远程协助用户进行操作有效得多。

该工具在Windows Server 2012中仍旧存在,可以记录并自动生成文档记录客户端与服务端系统的重要活动。当需要进行重要配置和配置操作时,可以利用其创建记录库,供工作人员后期参考。要启动PSR.exe,单击开始,在搜索中键入PSR,然后可以在搜索结果列表中看到PSR小程序。

文档记录是否有用,在任何数据中心内没有既定的判断依据,所以不同组织文档的数量与质量无法对比。审阅与改进文档,允许其他IT人员查阅资料和提供有关清晰度、完整性的反馈建议。而且数据中心经理们应该腾出时间来定期培训,让IT人员熟悉现有的文档,在需要时就不会手忙脚乱了。

作者

Stephen J. Bigelow
Stephen J. Bigelow

数据中心和虚拟化网站的高级技术编辑,拥有20年的PC和技术写作经验。

翻译

陈德文
陈德文

TechTarget中国特约编辑

相关推荐