知识卡片
定制扩展须配套清晰文档
团队在标准语言或平台上加入专有扩展时,用户需要知道哪些行为偏离标准以及如何使用;只交付编译器而不提供准确手册,会让功能停留在实现者手中。Edom的高质量指南页让程序员能据此编写可用驱动,说明文档是产品可用性的一部分。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第30章 汇集团队的声音 · 查看原书依据
我们的设备驱动手册易于理解,程序员们阅读后就可以编写出可用的驱动程序。我把第一年的全部时间都用来为整个FORTRAN语言编写文档
参考来源
- 位置:《团队之美》第30章《汇集团队的声音》(Andy Oram,源文件:_epub-src/OEBPS/Text/part0048.xhtml)
- 结论依据:Edom在标准FORTRAN上增加VAX扩展与自有功能,作者用一年记录语言文档;设备驱动手册又使程序员读后能编写可用驱动,说明产品特有能力需要准确文档支撑使用。
- 原始内容:我们的设备驱动手册易于理解,程序员们阅读后就可以编写出可用的驱动程序。我把第一年的全部时间都用来为整个FORTRAN语言编写文档……因为我们在标准FORTRAN的基础上添加了大量的VAX扩展以及我们自己的功能增强。