在此页面上

当其背后的推理也能传播时,结果传播得更远。没有定义的图表、没有约束的设计或没有假设的建议,随着它远离作者,就越难使用。

写下决定

好的文档不需要记录每一次对话。它应该解释决策、重要的替代方案以及可能导致决策改变的证据。

这为未来的合作者提供了比复制现有模式更有用的东西。它让他们能够识别模式何时不再适用。

保留反例

失败的测试是对边界的描述。保留它使该边界可供下一个人使用,否则下一个人可能会在更昂贵的时刻重新发现它。

使下一步可见

每一个有用的笔记都应该帮助某人继续工作。这可能意味着一个开放性问题、一个可重现的示例,或者一个关于仍未验证内容的清晰陈述。

目的不是详尽的文档。它是连续性:足够的上下文,以便下一次贡献可以从上一次结束的地方开始。