技术写作与文档2022news.ycombinator.com
Ask HN:有没有好用的 Markdown 编辑器?
Ask HN: Is there any beautiful Markdown editor?
导读
这是一则 HN 求助帖:发帖人找不到界面好看的 Markdown 编辑器,甚至说没有漂亮的 UI 就没法写作。评论区既有工具推荐(Typora、Ghostwriter、Nota、Caret、VS Code),也有对“工具越做越复杂”这一循环的反思。对写作者来说,它提醒我们:格式越简单,写作越自由;而反复寻找“完美工具”本身就是一种拖延。
可以直接用的写作要点
- 01
Markdown 的初衷是让人在纯文本里就能读和写,别让排版需求反过来绑架写作。
- 02
警惕工具膨胀的循环:功能越加越多,最后反而需要一个编辑器才能动手——先把字写出来,再谈工具。
- 03
选编辑器时优先看写作体验是否顺手(UX),而不是功能清单有多长。
- 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 条写作要点编辑精选