技术写作与文档2018abricotine.brrd.fr
Abricotine：所见即所义的 Markdown 编辑器
Abricotine – WYSIWYM Markdown editor – open source and cross platform
导读
这篇介绍的是 Abricotine：一个开源、跨平台、所见即所得（WYSIWYM）的 Markdown 编辑器。评论没有停留在功能上，而是回到一个老问题：Markdown 写作到底需不需要专门的编辑器，工具应该为内容服务还是反过来。写作者可以借此想想自己的写作工具链：是用纯文本还是专用应用，以及协作需求该怎么安排。
可以直接用的写作要点
- 01
把稿子存成 Markdown 这类纯文本格式，就不必绑定某个编辑器，工具换了内容也不丢，适合长期写作和归档。
- 02
所见即所得编辑器能降低 Markdown 的上手难度，方便不折腾技术的人；但要小心别让排版和预览分散了写作注意力。
- 03
缺的功能（比如表格里写公式、org-mode 的特性）可以用 pandoc 过滤器这类外部工具补上，不必为此换编辑器。
- 04
需要多人一起写时，HackMD 这类支持协同编辑的在线 Markdown 平台，可能比桌面应用更合适。
HN 评论精选
Markdown 的哲学是内容重于编辑器，专用编辑器的主要价值在于降低非技术用户的门槛。
Markdown 真的需要一个专门的编辑器来解决什么问题吗？从理念上说，我把 Markdown 归为「纯文本编辑器不重要」的那类语言。我最近给 pandoc 写了个（很简单、只对我自己有用的）过滤器，让 Markdown 表格里能写公式。Markdown 真正缺的是 org-mode 的那些功能，但不该因此和编辑器绑在一起。不过另一方面，这样的编辑器让非技术用户也能更容易用上 Markdown，这总是好事。
turbinerneiter查看英文原文
Is the editor really a problem to solve for Markdown? Philosophically I regard Markdown as a language in the text-only-editor-unimportant family. I recently built a (simple, only works for me) filter for pandoc that allows for formulas in Markdown tables. org-mode features is what Markdown is missing, but without the marriage to the editor. At the same time: an editor like this makes Markdown more accessible for non-hackers, which is always good.
在线协作编辑的 Markdown 平台可以替代桌面应用，多人写作时尤其方便。
顺带一提：我最近开始用 hackmd.io 写 Markdown，它支持完整的 GitHub Markdown，甚至更多；最棒的是协同编辑。我完全不怀念桌面版 Markdown 应用了，也很期待试试他们的幻灯片功能。（声明：我和他们没有任何关系，现在纯粹是个粉丝。）
NightMKoder查看英文原文
On a related note: I’ve recently started using https://hackmd.io/ for markdown. It supports the full gh markdown and more. The best part is the collaborative editing. Big thumbs up to the guys working on the product - I haven’t missed desktop apps for markdown at all. I’m looking forward to trying their slideshow features. Disclosure: I have no affiliation with them :). I’m just a fanboy at this point.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选