良好的文档不仅可以避免理解

[jarinislamfatema]

某件事物如何运作的差距，还可以让任何人都能更轻松地担任某个角色并发挥效力。 但问题是，糟糕的文档实际上比没有文档更糟糕。如果文档写得不好，使用起来会非常困难，并且会让员工感到困惑，以至于除非弄清楚那个特定的线索，否则什么也做不了。 而且文档不仅适用于开发人员。文档可用于公司内部的任何内容，例如： 如何使用软件 如何使用硬件 任何给定的工作流程 一般最佳实践 员工入职 人力资源和人员配置 尽管文档编制可能需要一些时间，但这种努力是值得的，因为从长远来看，您的公司将节省大量时间，并避免将来出现混乱和障碍。

话虽如此，您的开发人员如何改进他们的文档？让我们来看 建筑师数据库 看一些想法。 制定文档政策 这应该是您改进文档所做的第一件事。无论您是刚开始这一旅程，还是正在承担改进所有现有文档的任务，都没关系：花时间为流程和最终结果制定政策。 对于这些政策，您需要决定文档中包含的内容、其目标受众、首选的文档工具、注释的作用、文档是否存放在版本控制系统（如 Git）中，以及文档是否遵循特定的样式指南。

制定这些政策后，请确保所有文件都严格遵循这些政策。 使用主动语态 为了创建简洁、易于理解的文档，您的开发人员需要了解如何使用主动语态。主动语态的反义词是被动语态，它会大大降低清晰度、一致性和效率。 主动语态与被动语态的一个简单例子如下： 主动语态——鲍勃跑了一场马拉松。 被动语态——鲍勃参加了一场马拉松比赛。 使用主动语态时，主语执行动作（鲍勃跑了一场马拉松）。