技术写作与文档2022news.ycombinator.com
Ask HN：2022 年最好的技术写作平台是哪个？
Ask HN: What's the best platform for technical writing in 2022?
导读
这是一个 HN 求助帖：作者多年来只为自己写笔记和文章，如今想把内容公开、顺便积累一点读者，但不确定 2022 年该选个人博客、Medium、Substack 还是别的平台。高赞回复没有推荐某个热门平台，而是集中讨论两条判断标准：平台会不会“烂掉”，以及写博客的工具会不会反过来占用写作时间；对任何准备长期写作的人都有参考价值。
可以直接用的写作要点
- 01
选平台先问两个问题：这个平台几年后还在不在，以及维护工具会不会挤掉写作时间；能满足这两点的往往是最朴素方案（纯 HTML、Markdown）。
- 02
把已有笔记一次性导入，并把同步流程自动化，能显著降低开始公开写作的门槛。
- 03
别把分发绑在单一平台上：自有站点加 RSS 再同步到 Medium、用邮件列表把 RSS 转成 newsletter，是成本很低的组合。
- 04
相比卖订阅、卖知识，靠公开写作证明专业能力（换来更好的工作或咨询机会）通常是更可靠的变现路径。
HN 评论精选
用纯 HTML 和 GitHub Pages 这类最简单的方案，既不会因平台衰落而失效，也不会让维护工具占用写作精力。
我折腾过一圈：WordPress、Blogger、Medium、自己写的 Vue 站点、自己写的 Go 服务、树莓派，什么都试过。最后我开始在 GitHub Pages 上用自定义域名写纯 HTML 文件，非常喜欢。之前那些方案要么是平台会烂掉，要么是变成了会分散写作精力的爱好；纯 HTML 加 GitHub Pages 同时解决了这两个问题。
glacials查看英文原文
After a long journey jumping around I’ve recently started writing plain HTML files in GitHub Pages with a custom domain and I have been loving it. I’ve been on WordPress, Blogger, Medium, a custom Vue site, a custom Go server, a Raspberry Pi, the works. Each was either a platform that could rot, or a hobby that could distract me from writing. Raw HTML on GitHub Pages has solved both these problems for me.
先把旧笔记批量导入并自动化同步，能降低开始公开写作的门槛。
我做了 mataroa.blog，一个简单的博客引擎，带导入功能。一个思路是把所有内容（如果都是文本文件的话）一次性导入进去，最终把这个过程自动化，让内容始终保持同步。Stavros 也有类似的困扰（notes.stavros.io）：他用 Joplin 写作，然后导出成 mdbook。
sirodoht查看英文原文
* I make https://mataroa.blog/ It’s a simple blogging engine with an import functionality. One idea would be to just import everything there (assuming they are just text files). Eventually automate this process to keep everything up-to-date. * Similar problem statement by Stavros in this website: https://notes.stavros.io/ He’s using Joplin [1] to write and then exports everything in an mdbook [2]. [1]: https://joplinapp.org/ [2]: https://github.com/rust-lang/mdBook
自有站点加 RSS 分发是个低成本组合；变现靠证明专业能力比卖订阅更现实。
如果你只是想写，我会选 WordPress，然后同步分发到 Medium（不确定能不能同步到 Substack）。再开一个 Mailchimp 邮件列表，让 RSS 自动生成 newsletter。你没提到想变现，但如果想，那时再考虑 Substack。我的经验是：靠写作证明自己的专业能力，从而拿到更好的工作或咨询机会，比卖知识获取权限容易变现得多；不过你的领域可能比我的更值得付费。
mooreds查看英文原文
If you just want to write, I'd go with wordpress and then syndicate to medium. I don't know if you can syndicate to substack. Set up a mailchimp mailing list account and have the RSS feed publish a newsletter. You didn't mention wanting to monetize your content, but if you do, then that's when I'd look at substack. In my experience, it's far easier to monetize your content by showing proof of authority for a better job or consulting than by selling access to knowledge. But your niche may be more monetizable than my experience.
选工具的标准是能长期存续、少维护、不让人分心。
Doom Emacs 加 org-mode。导出成 HTML 上传到网页，能存续很久，不需要多少维护，也不会被其他事情分心。
buscoquadnary查看英文原文
Doom Emacs + org-mode. Export as HTML upload to webpage, lasts forever, doesn't require a bunch of upkeep, and don't get distracted by all the other things.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选