好的文档要经历三个阶段。
第一个阶段是我们放下杂乱的想法。在这个阶段,我们可以解析流程——但它还没有准备好供其他人使用。
第二阶段是我们将其架构得足够好,以便从事该项目的核心团队了解我们的发展方向。
第三阶段是我们以团队以外的任何人都能理解的方式构建它。
最后两个阶段之间存在鸿沟。大多数文档从未进入第三阶段,因为它通常要求我们完全重写或重新构建似乎运行良好的文档。
但这正是经验丰富的作家所擅长的。他们专注于最终结果,而不是对一路走来的任何版本过度依恋或感到舒服。最终结果几乎总是简单的——尤其是与之前的版本相比。这就是为什么大多数文档没有进入第三阶段的原因。
简单就是困难。
原文: https://alearningaday.blog/2023/12/12/three-phases-of-good-documents/