6.4 对自己狠一点,开始写作吧
从有完整想法后才开始写走到用草稿、复现、反馈和修订推动理解变清晰,沿读者、主张、证据、复现与改稿建立写作闭环。
学习目标
- 能沿选择读者、写出主张、补充证据、邀请复现和根据反馈修订建立一篇可验证技术文章
- 能解释读者问题、中心主张、示例反例、复现步骤、误解和改稿之间的边界
- 能在正常、边界和故障场景中回答:为什么草稿、反馈和修订比等待完整想法更能推动理解清晰
为什么需要这一机制
本页依据刘欣《码农翻身》(2018 年第 1 版)及出版社公开书目信息,独立重构 6.4 对自己狠一点,开始写作吧。正文、代码、图示、实验和练习都是本课程重新设计的教学材料,不复制原书正文、插图、练习答案或代码。
6.4 对自己狠一点,开始写作吧 不能停在“等想完整了再动笔”。真实系统要解决的变化是从 有完整想法后才开始写 到 草稿、反馈和修订推动理解变清晰;技术写作先定义读者问题和中心主张,再组织证据、示例、反例与修改。发布后的误解和复现结果不是失败终点,而是进入下一轮修订的信号。
三个会让技术写作失真的陷阱
一个目录节点到写作证据
6.4 对自己狠一点,开始写作吧
在 ↡把读者、主张、证据、复现和反馈修订组织成可检查技术文章的方法。 中,一篇可复核文章可以先表示为
加法表达的是组成合同:主张必须有证据和例子,发布后的反馈必须能进入修订。文章字数、链接数量或作者的完整感都不能单独替代复现和读者理解证据。
选择读者
↡明确文章服务的读者、已有知识、问题场景、环境和期望结果的阶段。读者不是泛化的人群标签,而是一个可以描述的问题场景。先写读者想完成什么、有什么前置知识以及会在哪里卡住。
写出主张
↡用一句有范围、有条件和可被反驳的结论说明文章要让读者相信或做到什么的阶段。主张要有边界和失败条件。写得越宽,所需证据越多;先缩小主张,才能让第一版草稿可检查。
补充证据
↡为主张补上数据、代码、步骤、示例、反例、版本和限制,使读者能检查结论的阶段。证据不是装饰性链接。最小证据应说明输入、环境、动作、预期和实际结果,反例则说明结论不能外推到哪里。
邀请复现
↡让读者或同事按公开步骤在明确环境中重做示例,并记录成功、失败和最早偏离的阶段。邀请别人复现会暴露作者默认的环境和未写出的步骤。记录版本、依赖、输入、输出和错误,才能区分文章缺口与环境差异。
根据反馈修订
↡根据读者误解、复现失败、问题和对照结果修改主张、结构、证据或边界并重新验证的阶段。修订不是把文章写得更长,而是让关键路径更清晰。每次改动都应说明解决了哪一个误解,以及同一案例是否重新通过。
最小可重放实现
reader = choose_reader(problem, context)
claim = write_bounded_claim(reader)
draft = add_evidence_examples_and_counterexamples(claim)
replay = invite_reader_to_reproduce(draft)
article = revise_from_feedback(draft, replay)
assert verify_claim(article, replay)这段实现草图只表达技术写作合同,不复制原书叙事或代码。实际运行时应保存读者问题、主张、证据、示例、反例、环境、复现日志、误解和改稿版本,使另一位读者能够从干净状态重放。
五步复核一篇技术文章
1. 选择读者与问题场景
记录读者前置知识、环境、目标和最可能的卡点。先预测文章最小成功是什么,再避免从作者想讲什么开始堆内容。
Lab
技术写作反馈实验
先预测缺口会落在读者、主张、证据还是反馈,再切换可复现草稿、读者边界与术语堆积样本。
读者问题明确,主张有边界,示例可以按步骤重放
reader=fixed → claim=bounded → example=replayable → feedback=actionable
判定
accept:草稿已形成验证闭环
当前样本:可复现草稿;保存读者、主张、步骤、环境、反馈、改稿和复位轨迹。
正常、边界与故障证据矩阵
| 样本 | 只改变的变量 | 预期判定 | 必存证据 |
|---|---|---|---|
| 正常 | 读者、主张、环境、步骤和案例固定 | 读者可以复现并理解主张 | 读者问题、主张、步骤、结果、反馈 |
| 边界 | 环境、版本、输入或读者前置知识改变 | 缺口与主张边界可解释 | 假设、偏离、反例、未覆盖范围 |
| 故障 | 只有术语和链接,没有最小复现 | 拒绝把篇幅和引用当证据 | 读者卡点、缺失步骤、误解、改稿 |
故障诊断:先分开读者、主张与复现
- 读者侧:查问题场景、前置知识、环境和期望结果;读者不明确时,文章无法定义成功。
- 主张侧:查结论范围、条件、反例和失败语义;主张过宽会让证据永远不够。
- 证据侧:查输入、版本、步骤、预期、实际、示例和限制;链接不能代替可执行动作。
- 反馈侧:查复现日志、最早偏离、误解、改稿和重放结果;拒绝修订会让同一缺口反复出现。
如果读者无法开始,先补问题和前置条件;如果读者能开始但结论偏离,查主张边界和反例;如果复现失败,查版本、依赖和遗漏步骤;如果反馈存在但文章不变,检查改稿是否针对最早偏离。每次只改变一个控制量并重放。
术语表
名词解释
本章出现的专业名词,用大白话再讲一遍。
- 6.4 对自己狠一点,开始写作吧
用读者、主张、证据、复现和反馈修订建立可检查技术文章的方法。
- 选择读者
明确读者、问题场景、前置知识、环境和期望结果的阶段。
- 写出主张
写出有范围、有条件且可被反驳的结论的阶段。
- 补充证据
为主张补数据、步骤、示例、反例、版本和限制的阶段。
- 邀请复现
让读者在明确环境按步骤重做并记录偏离的阶段。
- 根据反馈修订
根据误解和复现结果修改文章并重新验证的阶段。
练习
练习
问题 1(6.4 对自己狠一点,开始写作吧): 为什么等待想法完整后才开始写,反而会拖慢理解变清晰?
问题 2(选择读者、写出主张、补充证据): 怎样把一个宽泛技术主题收窄成第一版可检查文章?
问题 3(邀请复现、根据反馈修订): 读者在另一环境复现失败,作者应该如何判断是环境差异还是文章缺口?
本页小结
6.4 对自己狠一点,开始写作吧 的关键不是等完整想法,而是把读者、主张、证据、复现和修订放进同一条反馈链。完成标准是定位读者最早偏离,证明改稿解决了具体误解,并在重置后用同一案例重放出可解释结果。