文档手册与清单文档清单
过去，我曾与部门中的其他人讨论过文档，尤其是详细程度和要求。在他们看来，文档是X出问题时要执行的Y事情的简单清单。 我不同意。我认为这是假定IT中的所有问题都可以轻松归结为恢复过程的简单清单。我认为这完全忽略了情况的复杂性，并且由于该部门的其他人员并不总是对此问题有深入的了解（这就是为什么我要编写文档的原因-因此他们需要参考一些内容），文档应包括一些基本的背景材料，例如： 所讨论的（子系统）的目的 为什么以这种方式配置 实施设置/过程时发生的事件期望 可能导致程序失败的潜在问题 但是，我对此颇为不满，因此需要将我的文档重新编写为一种形式，该形式为“应用ABC的步骤才能解决问题X”。 我经常听到它需要放在一张纸上的哀叹。 尝试通过单页文档以这种方式向某人解释Squid ACL的配置，包括故障排除。那只是恢复等待清单中“等待写入”的六个文档之一。 我倡导的方法真的过分吗？还是他们说的对，我应该在这里管我的事，然后给他们写一个简单的清单？我担心的是，无论您编写过程清单的质量如何，它都无法真正解决需要SysAdmin仔细考虑的问题。如果您花时间做一份恢复程序清单，最终导致无法解决问题（由于文档的关注范围狭窄，由于文档中没有其他因素），并且您需要文档的目的是避免再次重新阅读手册页，Wiki和网站，那我为什么要进行这些动议呢？我是不是太担心了，还是这是一个真正的问题？ 编辑： 当前部门中没有服务台职位。文档的读者将是其他管理员或部门负责人。