如何编写服务器文档记录

简介:

任何一家数据中心都应该为发生最坏的情况做好准备,但更要不惜一切代价的尽量避免发生最坏的情况。而通过相应的系统文档记录则有助于避免您数据中心发生严重的错误。

在任何一家数据中心,最大的疏漏之一便是缺乏明确和翔实的服务器文档记录。

企业数据中心的IT专业人员知道如何安装和配置最复杂的设备,但往往并不具备很强的沟通能力。这样一来,企业组织往往要依赖于管理人员的记忆或非正式的方式来传播知识,而因为其管理员忘记他们曾经做过什么工作;或因留下知识真空,往往造成了本来可以避免的整合、升级和故障排除问题。

以下是一些有助于改善您企业的数据中心服务器文档记录的策略。

强大的服务器文档记录

对于系统或服务器文档记录而言,其实并没有一个单一的标准。其重点并不在方式和路径上,而重点则是在于建立一副“地图”,规定您企业的每款系统将如何进行配备、配置、并整合到数据中心,使得其他相关IT专业人员可以理解、测试、升级和实施故障排除,同时让生产环境得以实现最少的时间浪费。

每家企业组织的服务器和系统的文档都是不同的,各自有着完全不同的标准和详细程度。但也有可以用来支撑杂乱无章的文档记录的办法。

列表清单。从硬件库存清单开始,包括了所有主要组件的列表。接下来,是一份软件清单,详细列出不同的操作系统、虚拟机管理程序、虚拟机(和所有的操作系统)、驱动程序、应用程序(工作负载)、以及所有相关的许可授权信息。

固然,任何一款系统库存工具都可以详细记录硬件和软件组件,以及随着时间推移的相关更新。但是,一份打印的组件列表则能够为您企业组织提供一份完整的、一目了然的视图信息,可以很容易地拿来与系统采购规格进行比较。将库存报告与原始的安装或恢复介质,以及任何原始供应商的文档,如手册或设置指南一起进行整理。

指令说明。下一步,用文档翔实记录与每款系统的安装和配置相关的所有信息,从其固件(BIOS设置)选项开始。同样,用文档记录脚本。众所周知,命令行脚本是缺乏注释的,所以,添加注释能够在未来更容易的进行修改或故障排除。然后,部署一个版本控制系统,以帮助管理员跟踪每一个版本,并理解当一款系统何时可能在使用旧的或错误的脚本。

以文档明确记录系统是如何集成整合到较大的数据中心的,包括其LAN地址、媒体访问控制、或MAC地址、每个网络接口卡的端口、并且为该系统是如何与网络交换机互连的进行额外的注释。综合起来,这些信息构成了企业内部的IT专业人士跟进和调查企业数据中心当前网络架构、和为改善基础设施提供相关建议的指引地图。

系统管理工具能够自动化至少一部分的这类信息的收集任务。各种工具会频繁的取代更加正式的文档,因为报告动态的变化,而不会变得过时。不管采用怎样的方法,都需要随着相关变化的发生而部署实施一个过程以更新系统以及与之相关的文档记录。错误的文档记录可以比没有文档记录更糟糕。

该文件在哪里?

鉴于其是作为系统和服务器文档内容的情况,故而并没有明确的选择说起应该被保存在何处。

理想的情况下,系统文件记录最好应靠近物理系统,确保当正常运行时间面临危险时,就能够快速访问重要的细节。将该文件记录保存在除该系统本身以外的地方。文档记录是为了帮助排除故障,如果该系统运行失败或变得无法访问,将注释文档保存在系统的本地硬盘上不会有很大的裨益。

在一个单一的位置整合文件也很常见。如果您企业选择了这种方式,请务必为说明手册、配置文件和数据中心的其他细节留出空间架子。避免文件的冗余副本——一个副本上的改变往往并没有迁移到后续副本,从而会导致错误和混乱。

文档所保存的介质本身并没有什么实际差别。无论是以纸张打印、或是刻录在光盘上的文件、保存记录在闪存驱动器上 ——甚至是在主存储区域网络上的电子版的手册库和文档文件:取决于您企业数据中心环境的规模和复杂性的不同,这都是可以接受的介质。系统管理工具可能会产生极少数的硬拷贝文档。但请务必确保一致性和整合,使每一套的细节都是一应俱全的。

小心处理服务器文档记录

一般情况下,一旦系统实际进行了配置和部署,伴随一台新的服务器的供应商文档的价值通常是有限的,但最好还是将您企业所开发新的文档与供应商文档同时保存。

随着越来越多的供应商开始转向提供基于网络的文档和指南,供应商文档的容量变得越来越大,及其文档的杂乱的问题已经变得越来越不成为一个问题了。例如,供应商们可以基于知识的不断发展而更新他们的在线文档,进而帮助处理错误、疏漏、排除故障和提供解决方法。

尽管如此,当一款老化系统更改用途时出售给其他用户或重新分配给其他业务部门),原始文件和当前配置的详细信息的利用价值便增加了。

为了您的文档方便

文档记录必须清晰准确——细化到下至一个复杂安装的具体按键或鼠标点击到配置的过程。手动记录详细的活动是可能的,但跳过某些步骤的可能性会很高。

借助工具记录程序,并为文档用户提供关键环节的一步一步的深入了解和洞察。

其中一款工具是微软的问题步骤记录器(PSR.exe),最初是在Windows 7和Windows Server 2008 R2中推出的,以帮助支持人员看到在远程用户的桌面台式机发生了什么状况。 IT管 理员认识到,记录并针对每一次的鼠标点击发表评论,然后保存该活动到一个压缩的MHTML报告的功能,可能会更多的用于远程用户活动。

该工具在Windows Server 2012中继续推出,可记录客户端和系统服务器端的重要活动。其创建了一个记录库,当工作人员需要处理重要的设置和配置活动时可以参考。要启动PSR.exe,只需单击开始,在搜索栏键入 psr,然后单击在搜索结果列表中出现的PSR小程序即可。

对于一家数据中心的任何部分,都没有既定的文档记录标准,

有用于,所以文档记录的数量和质量会因企业组织机构的不同而有不同的变化。同行间的评审有助于文档记录的改进,故而请允许其他IT人员阅读您企业的文档记录材料,并请他们就其清晰度和完整性提供反馈。而数据中心经理们则应该抓紧时间进行定期的培训,使IT员工尽快在他们需要用到现有的该文档记录之前,熟悉它。
本文转自d1net(转载)

相关文章
|
12月前
|
Web App开发 存储 C#
C# 10分钟入门基于WebOffice实现在线编辑文档,实时保存到服务器(所有office,兼容WPS)
C# 10分钟入门基于WebOffice实现在线编辑文档,实时保存到服务器(所有office,兼容WPS)
|
9月前
|
前端开发 Java 关系型数据库
【Java用法】使用Java导出word文档的解决方案(适用于从服务器上下载到本地电脑)
【Java用法】使用Java导出word文档的解决方案(适用于从服务器上下载到本地电脑)
484 0
|
弹性计算 容灾 安全
如何购买阿里云服务器(文档指南)
如何购买阿里云服务器(文档指南),阿里云百科来详细说下这两种方式购买云服务器的流程,购买活动机价格便宜,只是可选配置较为固定,就那么几款,简单选择地域节点即可;自定义购买选择范围广,选项配置也会比较复杂,当然价格会稍微贵一些。
80 0
如何购买阿里云服务器(文档指南)
|
网络协议 C语言 C++
【Socket】C语言编写Web服务器
【Socket】C语言编写Web服务器
|
SQL 关系型数据库 数据库
PostgreSQL 12 文档: 部分 V. 服务器编程
部分 V. 服务器编程 这部分关于使用用户定义的函数、数据类型、触发器等扩展服务器功能。这些是高级主题,读者应该在理解了有关PostgreSQL的所有其他用户文档之后才阅读这些主题。这一部分的后面一些章节描述PostgreSQL发布中可用的服务器端编程语言,以及与服务器端编程语言相关的一般性问题。在深入研究服务器端编程语言的材料之前,请至少阅读第 37 章中前几节(覆盖函数)。
70 0
|
监控 网络协议 安全
PostgreSQL 12 文档: 部分 III. 服务器管理
部分 III. 服务器管理 这部份覆盖了PostgreSQL数据库管理员感兴趣的主题。包括软件安装、搭建和配置一个服务器、管理用户和数据库以及维护任务。任何想要运行一个PostgreSQL服务器的人(即使是用于个人用途而不是生产环境),应该熟悉这一部分覆盖的主题。 这部份的信息大致上按照一个新用户会阅读的顺序来安排。但是章节都是自组织的并且可以根据需要独立阅读。这一部分的信息也是按照叙事风格组织的。需要一个特定命令的完整描述的读者应该看看第 VI 部分。
72 0
|
网络协议 Unix Linux
linux网络编程(三) TCP通信时序与多进程/线程并发服务器的编写
linux网络编程(三) TCP通信时序与多进程/线程并发服务器的编写
306 0
linux网络编程(三) TCP通信时序与多进程/线程并发服务器的编写
|
编译器 Go
第四十七章 开发自定义标签 - 服务器文档对象模型
第四十七章 开发自定义标签 - 服务器文档对象模型
63 0
|
NoSQL Java Linux
云服务器学习文档
大家好,我是一名计算机专业的学生,现就读于洛阳理工学院,在学校的数据科学与大数据技术专业进行学习。现在是一名大四的应届生。在进行学习云计算的课堂上了解到“飞天加速计划·高校学生在家实践”。老师,在教课过程中,要求我们熟练使用Xshell,因此我参加这个飞天加速的活动,使用阿里云的云服务器。我相信阿里这个平台,可以让我更好的对计算机专业进行学习和实践。下面我将介绍一下我学习云服务器的过程
143 2
云服务器学习文档
|
SQL 安全 Unix
Hive 勒索软件新变体:用 Go 语言编写|现在专门以 Linux 服务器和 FreeBSD 作为攻击目标
Hive 勒索软件新变体:用 Go 语言编写|现在专门以 Linux 服务器和 FreeBSD 作为攻击目标
152 0
Hive 勒索软件新变体:用 Go 语言编写|现在专门以 Linux 服务器和 FreeBSD 作为攻击目标