技术写作与文档2021marktext.app
一款注重速度与易用性的跨平台 Markdown 编辑器
A cross-platform Markdown editor focused on speed and usability
导读
这是一篇介绍跨平台 Markdown 编辑器 MarkText 的帖子，评论区的讨论很快转向"哪些所见即所得（WYSIWYG）Markdown 编辑器真正好用"，并集中推荐了 Typora 等工具。对写作者来说，它的价值不在软件评测本身，而在于提醒我们：写作环境的选择（是否即时预览、是否极简无干扰、文件是否纯文本可长期保存）会直接影响写作的顺畅度与产出。
可以直接用的写作要点
- 01
优先选择"边写边看最终效果"的编辑器：省去在 Markdown 源码和预览窗口之间来回切换，能明显减少思路被打断的次数。
- 02
用纯文本 Markdown 存稿：文件轻、可版本管理、十年后任何工具都能打开，避免被某款软件锁定。
- 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 条写作要点编辑精选