技术写作与文档2015caret.io
Caret:一款更好的桌面 Markdown 编辑器
Show HN: Caret – Better Markdown Editor for the Desktop
导读
这是 Caret 桌面 Markdown 编辑器的发布帖,讨论集中在写作时真正影响体验的功能:字数统计是否常驻、实时预览要不要一直开着、能否导出 PDF 分享。对写作者来说,它提醒我们:工具选择应服务于写作流程本身,而不是堆功能。
可以直接用的写作要点
- 01
让字数统计常驻可见,并支持查看选中段落的字数,有助于控制篇幅和节奏。
- 02
不必全程开着实时预览,用顺手的快捷键按需查看,能减少写作时的分心。
- 03
定稿后导出 PDF 等静态格式,方便把成稿发给没有装工具的读者。
- 04
选工具时优先看它能否衔接你的发布流程,比如识别博客的 YAML 头部信息。
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选