技术写作与文档2025youtube.com
卡罗琳·罗斯口述史:《Inside Macintosh》的撰写者(2023)[视频]
Oral history of Caroline Rose, writer of Inside Macintosh (2023) [video]
导读
这是一段口述史访谈视频,讲述 Caroline Rose 自 1982 年起在 Apple 担任技术写作的经历,她是《Inside Macintosh》的主笔与编辑。正文标出两段重点:Apple 时期从视频 1:22:00 开始,NeXT 时期从 1:58:00 开始。对写作者来说,它示范了如何把大量零散的技术知识整理成一部体例统一、可被外人读懂的“书”。
可以直接用的写作要点
- 01
把庞杂的资料当成一本有统一声音的书来写,而不是一堆互不相关的条目:Rose 以“主笔兼编辑”的身份统一了《Inside Macintosh》的体例与语气。
- 02
固定术语与格式:同一个概念在全书中始终用同一个词、同一种排版,读者就不必反复重新适应你的文档。
- 03
主动把“内部人默认的知识”写出来:技术写作的核心动作,是不断向懂行的人追问那些他们觉得“不用说也知道”的前提。
- 04
用具体的人、时间、地点和冲突来记录项目历史,比抽象总结更可读,这也是口述史值得写作者借鉴的叙事方式。
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架,把技术文档按「读者的目标」分成四类:教程(学习导向)、操作指南(问题导向)、参考(信息导向)、解释(理解导向)。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》,主题是如何写好一份设计文档;对写作者来说,它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程(两门),讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息,评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账:版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选