技术写作与文档2013nerdplusart.com
Markdown 是写作的未来
Markdown is the Future of Writing
导读
这篇文章主张 Markdown 是写作的未来，因为它让你专注于「写什么」而不是「看起来怎样」。评论区围绕「好文笔是否需要排版语法」「纯文本与所见即所得编辑器孰优孰劣」展开争论，对写作者重新思考工具与内容的关系很有启发。
可以直接用的写作要点
- 01
先把内容写出来，格式留到后面：Markdown 的极简语法让你专注于表达而非外观。
- 02
好文章靠文字本身立住，标题、斜体只是辅助；过度依赖排版标记有时是在掩盖结构上的薄弱。
- 03
用 Word 等编辑器时善用「样式」功能，像写 CSS 一样统一设置，别逐段手动调字体字号浪费时间。
- 04
选定一套稳定的标记语法并坚持使用，避免在方言差异间反复折腾，消耗写作精力。
HN 评论精选
好文笔靠内容本身，排版标记往往是结构不足的补偿。
最简单的反驳：好文笔不需要语法。Sinclair、Joyce、Fitzgerald 和 Twain 都不需要斜体或标题标签；正如把文章拆成列表是结构薄弱的表现，用标题标签标注某段内容等于承认失败，等于承认「嘿，看这里，这边有事发生」。（我很喜欢 Markdown，每天都用。）
jmduke查看英文原文
The easiest counterargument possible: Good writing doesn't need syntax. Sinclair and Joyce and Fitzgerald and Twain didn't need italics or heading tags: just like structuring a post as a list is a sign of structural weakness, designating something with a header tag is admitting defeat, is admitting "Hey, look at this, this means something is happening over here." (I love Markdown, and use it daily.)
Markdown 的极简语法把注意力从排版拉回内容。
核心要点：「Markdown 让你思考你在写什么，而不是它看起来怎样」——当你操作原始 HTML 时会有点难，而所见即所得又有点疏离。Markdown 用极简语法让复杂的想法落成文字，除了纯文本我想不出别的系统能做到。
eksith查看英文原文
The key takeaway : "Markdown lets you think about what you’re writing instead of how it looks"... which is arguably a bit difficult when you're manipulating raw HTML and a bit... detached on WISIWYG. Markdown allows sophisticated ideas to fall into text with a very simple syntax. I don't know of any other system that allows this except just plain text. Edit: Hmm... looks like agreeing with the article isn't popular for some reason.
用「样式」统一格式，把时间留给写作本身。
然而不知怎的，所有所见即所得编辑器都打败了 nroff 和 WordPerfect。个人经验：用文字处理器写作的诀窍是别在格式上花太多时间，只管写。另外要学会用「样式」，就像在 HTML 里用 CSS。我从 Samna/Lotus Ami 开始学着在所见即所得编辑器里认真写作，后来是 Word、Open/Libre Office，它们都有样式列表，用起来！别一段段地调字体、字号、间距。「样式」菜单大概是 Word 里藏得最好的秘密之一。
Roboprog查看英文原文
Yet, somehow all the WYSIWIG editors beat out nroff and WordPerfect. Personally, the trick to writing with a word processor is to not waste too much time on the formatting, and just write. Also, learn to use the "sytles", just like you use CSS in an HTML file. I first learned to do significant writing in a WYSIWIG editor using Samna/Lotus Ami (accent on the i). Then Word, then Open/Libre Office. All of these have style lists. Use them! Don't waste time clicking on all the fonts, sizes, spacing, etc block after block. The "Styles" menu seems to be one of the best kept secrets in Word and similar word processors.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选