知识卡片

普通读书笔记卡 · 167.a.4

写文档暴露思路缺口

理解等级:初级

现象:很多开发人员最痛苦的事情就是写文档,有强烈的抵触情绪。原因很简单——打开 Word 不知道写什么、怎么写,不知道怎么把一件抽象的事描述清楚,不知道怎么把想法变成文字,不知道用什么形式能让别人理解。

建议:自己试着画一画原型、写一写设计文档、做一做需求分析。只有真正动手了,才能体会这项工作的特点、难点和自己的欠缺。

核心洞见:有时认为自己已经想得很清楚了,真要落实到文档上,才发现有那么多问题。写文档的过程就是把思想具体化的过程,当写不出来时,根本原因是思路还不够清晰。

用法:把“写不出来”当作诊断信号,而不是表达能力问题——写不下去的地方,往往正是边界、流程、异常或数据关系还没想清楚的地方;在动手编码前先写设计文档,可以更早地发现这些缺口。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《架构基础:从需求到架构》第01章《第1章 如何规划自己的架构师职业生涯》1.2 如何打磨自己的架构能力(练习文档写作能力)(源文件:extracted/架构基础:从需求到架构/_epub-src/OEBPS/Text/Chapter_1_2.xhtml,来源项目 book-sources) - 结论依据:1.2节第6种方法指出开发者抵触写文档的原因,建议亲手画原型、写设计和做需求分析,并认为写文档是把思想具体化的过程,写不出来说明思路不清。 - 原始内容:写文档的过程就是把思想具体化的过程,当写不出来时,根本原因是思路还不够清晰。