知识卡片

普通读书笔记卡 · 1958.c.12.a.1.kn · 生成模型:未记录

文档更新应进入开发周期

理解等级:中级

把文档留到项目尾声集中补写,容易因时间不足而仓促过时。像维护代码模块一样维护文档,明确何时新增、修改和验证,使功能变化与解释同步进入开发过程。文档在同一仓库只是必要协作手段之一,不会自动让描述保持准确,也不意味着每次改动都要补写没有读者需求的长文。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元001;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。 - 结论依据:原文把文档看作代码模块维护,直接支持同步更新与验证,而非尾声集中补写;存入同库不证明描述自然准确。未在本机运行示例或改变环境。 - 原始内容: 但是在项目开始时设置一个文档过程,并且将文档看作是代码模块,这会使得文档的编写更加顺利。当遵循几条规则时,写作甚至会很有趣。 本章提供了一些开始文档化项目的提示。 7项技术写作规则,这是最佳实践的概述。 reStructured