483.【Unix/Linux 系统管理】本地文档维护

正如大多数人都接受锻炼和绿叶蔬菜对健康的好处一样，大家也都欣赏良好的文档，对文档的重要性也有模糊的认识。遗憾的是，这未必代表他们会在没有敦促的情况下编写或更新文档。我们为什么要那么重视文档？

• 文档降低了单点故障的可能性。有工具能够立刻部署好工作站，用一条命令就能分发补丁，这样当然不错，但如果没有文档，而专家又出去度假或已经离职，那这些工具基本上也就没什么用了。
• 文档有助于可重现性。当实践和规程没有形成机构共识时，不可能得到始终如一的贯彻执行。如果管理员找不到操作只能，那他们就只能自由发挥了。
• 文档可以节省时间。编写时你不会这么觉得，但是当你花了好几天去解决一个以前已经搞定过，但是忘记了当时是如何解决的问题之后，大多数管理员都会相信这个时间花得值。
• 最后，也是最重要的，文档提高了系统的可理解性，使后续的修改都遵循系统应有的工作方式，如果修改仅基于片面的理解，往往不能很好地符合系统架构。熵随着时间的推移越积越多，甚至系统管理员也开始系统视为杂乱无章的修补集合。最终的结果往往是推倒一切重来。

本地文档应保存明确的指定好的位置，例如内部 Wiki 或第三方服务。确保需要文档的人能够找到文档并阅读（使其可搜索），每个维护文档的人都可以更改它。但要在可达性和保护之间取得平衡。