技术写作与文档2015tuhs.org
新发现的最早 Unix 手册草稿(1971)
Newly discovered earliest draft of a Unix manual (1971)
导读
这篇讲的是 1971 年 Unix 最早手册草稿(Edition Zero)的发现与复原,HN 讨论关注它作为原始文档写得清晰、完整。值得写作者读,因为它展示了技术写作如何用有限篇幅把核心概念和用法讲清楚,甚至足以支撑别人据此写代码。
可以直接用的写作要点
- 01
把文档写成可直接使用的说明书:先交代系统或对象最重要的职责与核心概念,再给操作细节。
- 02
清晰完整比篇幅更重要:早期草稿也能通过准确、简洁的说明让人据此动手。
- 03
开头用一句话点明核心定位,例如“Unix 最重要的角色是提供文件系统”,帮读者快速建立框架。
- 04
保留并公开早期草稿和版本,便于读者理解演进,也提醒自己先写出可用版本再迭代。
HN 评论精选
这份早期 Unix 手册写得清晰完整,单靠它就能支撑实际编程,说明好文档不必等到系统成熟。
难道只有我觉得这里的评论跑偏了吗?这是 Unix 最初的说明文档。以当时的情况看,它写得非常好,也相当完整。这是 Unix 的 v0,才刚刚起步。仅凭这份文档,你就能——而且确实有人这么做——写很多代码。
luckydude查看英文原文
Is it just me or are the comments here missing the point? This is the original writeup of Unix. It's amazingly well written and pretty complete for when it was done. This is v0 of Unix, it's barely started. You could, and people did, write a lot of code with just that doc as documentation. Maybe it's because I'm a Bell Labs fanboy, I find this doc impressive.
早期手册用一句话点明核心定位,也引出“一切皆文件”的历史语境问题:写作要交代概念背后的背景。
手册里说:“UNIX 最重要的角色是提供文件系统。”我查了手册提到的 TGM(TGML),显然是 Thompson 用来写 B 编译器的。后来我逛到 Multicians 网站。一些计算史叙述认为 Unix 是 Multics 项目的替代方案。Multicians 网站则说 Multics 对“文件”的概念很不同,也可以叫“段”,所以“文件”一词可能有歧义。我想问经历过的人:今天介绍 Unix 时常说“一切皆文件”,但我从没见过有人解释为什么。1970 年代的背景是什么?Unix 的“文件”概念是对 Multics 做法的回应吗?这份早期手册又说:“UNIX 最重要的角色是提供文件系统。”
aplorbust查看英文原文
"The most important role for UNIX is to provide a file system." I looked up TGM which is mentioned in this manual (TGML). Apparently this was what Thompson used to write the B compiler. Anyway, I ended up on the Multicians site. Some online accounts of computing history suggest UNIX was an alternative to the Multics project. On the Multicians site it suggests Multics had a very different concept of "files", which could also be "segments". There was apparently potential ambiguity regarding the term "file". Here's my question for anyone who was there: Today we often see the phrase "Everything is a file" being cited when introducing people to UNIX. But I have never seen anyone attempt to explain why. What was the context in the 1970's? Was the UNIX notion of "files" a reaction to the approach taken by Multics? Again, this early manual says: "The most important role for UNIX is to provide a file system."
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选