技术写作与文档2015github.com
Show HN：MarkRight——基于 Electron 的 GitHub 风格 Markdown 编辑器
Show HN: MarkRight – Electron-powered GitHub-flavored Markdown editor
导读
这篇 Show HN 介绍 MarkRight：一个基于 Electron、支持 GitHub 风味 Markdown 的编辑器。讨论从工具切换延伸到学术写作者从 Word 迁移到 Markdown 的现实障碍：脚注支持和修订追踪。对写作者来说，它提醒我们选写作工具时要优先看协作与版本管理需求，而不只是预览效果。
可以直接用的写作要点
- 01
想把团队从 Word 迁到 Markdown，先补齐脚注、修订追踪等协作刚需，再谈迁移。
- 02
用纯文本 Markdown 写作便于版本管理，也更容易和 Git 类工具结合记录修改。
- 03
选写作工具时用真实稿件试用，重点确认它是否支持你工作流中的关键扩展，而不只看预览是否好看。
HN 评论精选
学术写作迁移到 Markdown 的关键障碍是脚注和修订追踪等协作功能。
这很棒，谢谢分享！说来有趣，我正想用 Electron 做一个 Markdown 编辑器项目。我在学术环境工作，梦想把作者和编辑从 MS Word 吸引到 Markdown。可惜最流行的 JS 解析器 Marked 不支持脚注等扩展，而脚注对我的用例很关键。我最终梦想是有一个基于 Electron 的 Markdown 编辑器，能通过 git.js 之类支持行内“修订追踪”，有点像桌面版 prose.io。愿意分享使用 Electron 平台的体会吗？
katabasis查看英文原文
This is great, thanks for sharing! It's funny, I was just thinking about trying to use Electron for a markdown editor project. I work in an academic environment and fantasize about luring writers and editors away from MS Word into Markdown. Unfortunately it looks like the Marked library (the most popular JS parser) doesn't support extensions like footnotes, which are critical for my use-case. My ultimate dream would be to have an Electron-based markdown editor that supports inline "tracked changes" through something like git.js[1], sort of like a desktop version of prose.io. Care to share any thoughts about the experience of working in the Electron platform? [1]: https://github.com/danlucraft/git.js
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选