技术写作与文档2024scipress.io
Scipress.io：类似 Notion、Medium 与 MkDocs 的 Markdown 写作平台
Show HN: Scipress.io – a Markdown writing platform like Notion Medium MkDocs
导读
这是一个面向写作者的 Markdown 发布平台，它把 VS Code 编辑器搬进浏览器，支持代码高亮、KaTeX 公式、Tailwind 样式、提示框（admonition）、弹层等富文本组件，还能用付费墙变现。作者坦诚地说，项目做了一年、第一次在 HN 上发布，目前收入为 0 美元。对写作者来说，这篇文章值得读的地方在于，它展示了一种“内容与排版分离”的写作流程，以及技术写作需要什么样的排版组件。
可以直接用的写作要点
- 01
用 Markdown 写正文，把排版和样式交给平台或主题处理，写作时只专注于内容结构，不用分心调整格式。
- 02
技术类文章提前想清楚需要哪些组件，比如代码块、公式、提示框、可折叠的补充说明；有了它们，解释复杂概念时就不用堆砌长段落。
- 03
如果打算靠内容变现，先积累读者，再考虑上付费墙；作者公开说项目做了一年仍是 0 收入，这就是一个关于定价和分发顺序的提醒。
- 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 条写作要点编辑精选