好的文档不是偶然产生的。在一个人人都是发布者的世界里，创建文档的能力从来没有像现在这样容易过。但是创建对读者有价值的高质量文档需要实践和纪律。最好的文档有助于将知识传递给读者，而不太好的文档往往会引起混淆。

同样的想法也适用于创建IT文档，无论您是在映射基础设施、起草服务器和应用程序依赖关系还是准备软件审计。开始流程的最佳时间是在您需要它之前，但是如果您还没有开始，也不要担心，因为下面列出了创建it文档的最佳实践。

从一个计划开始

在规划阶段，你应该定义以下内容:

• 项目的目的和范围
• 有哪些资源
• 项目的时间表和可交付成果
• 该项目的预算

如果文档是为IT以外的同事准备的，您还需要按照您的计划考虑受众和他们的技术理解。就连格式也要由观众来决定。例如，如果你决定把所有的文档放在一个不起眼的SharePoint网站上，你不应该期望IT界以外的人知道它的存在。

这里的目标是确定需要创建哪些文档以及谁负责这些文档的期望。你的计划应该包括具体的日期和名称，否则它将更像是一个模板而不是一个实际的计划。计划也会让人们负起责任。一个好的计划将会减少花在创建文档上的时间，因为每个人都知道什么会被覆盖，什么不会被覆盖。

使用清晰简洁的语言

这说起来容易做起来难，即使你打算避免使用缩略语、流行语和公司用语。不要仅仅考虑你的听众，而是知道你的听众以及他们能理解和不能理解的东西。如果这意味着让财务或人力资源部门的人读一遍草稿，那就去做。让他们圈出不认识的单词。

大多数人如果不理解您想要与他们分享的内容，就会跳过您的文档。这听起来可能不重要，但如果您正在记录密码和安全策略呢?公司里的每个人都需要了解它们，如果他们在掌握安全计算的概念之前就忽视它们，风险是巨大的。

使用视觉效果

没有人喜欢一段又一段的阅读，没有任何东西可以打破单调。许多人认为技术文档一定很无聊，但事实并非如此。使用视觉效果帮助他人掌握复杂的主题。提供视觉效果可以让大脑从不同的角度处理问题。

这里的目标不是创建下一本宜家手册。有些概念最好是详细的，然后用一种视觉效果加以补充，这样会有助于而不是分散注意力。今天的演示软件包括用于创建视觉效果的工具，而Microsoft Visio等独立产品提供了许多选项来创建引人注目的视觉效果。

更新和完善

了解文档是否准确的唯一方法就是使用它。要求您的员工仅使用新文档来完成任务。当你发现有漏洞时，不要感到惊讶，因为你已经做了很多次，把部分略读了。

IT文档永远不会完成。每个文档都应该被认为是一个活的文档，它将随着事情的变化而更新和改进。谁监督文档的更新?这取决于项目的规模。例如，您可能希望有一个人来管理网络地形文档，因为它必须每天保持最新。根据紧急情况，可能每个月或每个季度更新其他文档。

结论

有很多工具和顾问可以帮助你开始。随着公司的发展，您会发现自己越来越依赖于IT文档，特别是随着越来越多的IT项目和基础设施转移到云计算和公司之外。理解依赖关系和许可限制是两个例子，说明缺乏文档可能会导致应用程序崩溃和严重罚款。

您总有一天会需要文档，所以为什么不现在就开始呢?