知识卡片

普通读书笔记卡 · 3447.a.1

文档划定可依赖的承诺

理解等级:高级

接口可观察行为很多,文档应明确哪些操作、属性、质量保证和假设是对调用者的承诺,分别满足实现者、维护者、集成测试者与分析者。未发布行为也可能被大量调用者依赖,这正是Hyrum定律提醒的演进压力;不能以“没写过”掩盖现实迁移影响,也不必承诺所有偶然实现细节。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • 软件接口 · 查看原书依据

      The documentation of the interface covers a subset of that behavior: It lays out what we want our actors to be able to depend on. “Hyrum’s law” (www.hyrumslaw.com) states: “With a sufficient number of users of an interface, it does not matter what you promise in the contract: All observable behaviors of your system will be depended on by somebody.” True enough.

    参考来源

    - 位置:《Software Architecture in Practice, 4th Edition》第15章《软件接口》(来源项目:book-sources;源文件:extracted/Software Architecture in Practice, 4th Edition/_epub-src/ch15.html) - 结论依据:所引连续原文给出本卡机制或取舍;条件与示例结合本节已读上下文解释。 - 原始内容:The documentation of the interface covers a subset of that behavior: It lays out what we want our actors to be able to depend on. “Hyrum’s law” (www.hyrumslaw.com) states: “With a sufficient number of users of an interface, it does not matter what you promise in the contract: All observable behaviors of your system will be depended on by somebody.” True enough.