练习必须有目标

“提高技术写作能力”太宽泛。一次只练一个能力:减少歧义、设计 procedure、采访 engineer、编辑 API example、重构导航或建立术语表。

尽量使用真实 artifact。有明确限制和真实读者时,反馈更有价值。

先练诊断,再练重写

拿一篇弱页面,不要马上改句子。先判断失败原因:受众不清?缺 prerequisite?概念和步骤混在一起?术语不一致?示例没有证明任何东西?

这样可以把编辑判断与文字润色分开。

用不同形式重建同一材料

把长说明改成 task,把 task 改成 troubleshooting,把产品说明改成 API quickstart。这个过程会暴露哪些信息是真正必要的,以及不同意图需要什么结构。

找正确的人给反馈

Subject-matter expert 检查事实,editor 检查清晰度,目标读者尝试完成任务。它们是三类不同 review,不要合并成一个“看起来不错”。

练习小型系统

基本写作稳定后,尝试 Vale rule、content schema、code sample validation 或 review checklist。现代文档质量来自写作能力与系统能力的结合。

刻意练习的价值,是把模糊的“经验”变成可以重复、可以看到进步的训练。

实践示例

把《技术写作者的刻意练习:训练真实工作,而不是流行词》变成一个短小、结果可观察的练习。选择一到两次练习就能完成的成果:一页操作步骤、一个 API 示例、一次前后对照编辑、术语清理或一个小型作品集案例。开始前先定义“更好”具体意味着什么。

保留过程证据,而不只保留最终页面:

  • 原始问题和受众;
  • 做出的决定和放弃的方案;
  • 读者、审阅者或专家的反馈;
  • 下一次会改变的一件事。

这比被动积累课程更有效。技术写作是在约束下反复做决定的手艺;一个完成并经过真实审阅的小练习,通常比从未交给读者的大型理论项目更有价值。

快速编辑检查

  • 练习必须有目标. “提高技术写作能力”太宽泛。一次只练一个能力:减少歧义、设计 procedure、采访 engineer、编辑 API example、重构导航或建立术语表。
  • 先练诊断,再练重写. 拿一篇弱页面,不要马上改句子。先判断失败原因:受众不清?
  • 用不同形式重建同一材料. 把长说明改成 task,把 task 改成 troubleshooting,把产品说明改成 API quickstart。
  • 找正确的人给反馈. Subject-matter expert 检查事实,editor 检查清晰度,目标读者尝试完成任务。

相关阅读