s_SEMICODER.新手程序员
博客
工程实践文档示例内容 · 展示与开发用途

让文档成为开发的一部分

好文档不是项目结束后的补充,而是下一次顺利开始的入口。

新手程序员··1 分钟阅读

项目放下一个月后,最难的往往不是写代码,而是重新想起来怎么启动它。

写给未来的自己

从三个问题开始:如何运行?为什么这样设计?发生故障时怎么办?把这些答案放在容易找到的地方。

让机器维护确定的信息

命令、路由和环境变量名称可以从代码生成。架构取舍需要人来解释。将两者分开,才能避免自动化覆盖重要的决策。

与代码一起审查

接口变了,文档也应该在同一个变更中更新。检查链接和生成结果很有用,但仍然需要确认文字描述是否符合实际行为。

一起讨论

评论规则 ↗

分享你的想法,让每一次交流都有收获。

还没有公开评论。欢迎留下第一个想法。