技术写作与文档2016typora.io
Typora:跨平台 Markdown 编辑器
Typora – A cross platform markdown editor
导读
这是 Typora(一款跨平台 Markdown 编辑器)的发布帖,评论主要围绕三点:无预览窗口的即时渲染体验、Beta 阶段的收费与迁移政策,以及“Markdown 这么简单,为什么还需要这么多编辑器”。它并非讨论写作技巧,但正好可以提醒写作者:工具该多轻、多重,会直接影响写作节奏和读者能否读到你的内容。
可以直接用的写作要点
- 01
边写边渲染、不弹独立预览窗口,能减少在“写”和“看效果”之间来回切换,思路不容易被打断。
- 02
坚持用纯文本 + Markdown 存稿,内容和软件解耦,多年后仍可读、可迁移到别的工具。
- 03
图表等富内容要考虑读者的处境:若对方必须装同一款软件才能看到,不如导出为图片或附纯文本说明。
- 04
选长期写作工具前先弄清它的收费与版本政策,别让日常写作流程依赖一个随时可能变卦的产品。
HN 评论精选
即时渲染省掉了预览窗口、体验流畅,但富内容格式要为读者的可读性着想。
我在 macOS 上每天用它,体验非常好。它没有独立的预览窗口,会自动识别内容块,在编辑与渲染之间切换,整体很精致。它支持 Mermaid 图表,我很喜欢,但我也在想:图表是不是该作为图片导入,因为别人必须装了 Typora 才能看到渲染效果。提醒一下它还是 beta 版;我仍希望它有一个更像 Evernote 的统一侧边栏,因为现在它依赖文件浏览器,没有内置的跨笔记搜索。
jkmcf查看英文原文
For those who check comments first... I use this daily on macOS and it is a fantastic user experience. The Markdown editor doesn't have a separate preview window. It auto detects your blocks and toggles between editing and rendering. Overall very polished. It has Mermaid ASCII diagramming support, which I love, but I wonder whether the diagrams should be imported images since you would need Typora in order to see it rendered. Reminder that it is still beta. I'm still hoping for a more unified Evernote-ish side bar since right now it depends on using a file browser of some sort, with no built-in search across notes.
质疑功能堆叠:Markdown 的优势本是简单可读,工具该服务写作而不是炫技。
我可能没抓住主要场景:为什么这里总能看到这么多不同的 Markdown 编辑器?Markdown 本身很简单,纯文本就能读,最多加点高亮,那这些编辑器的意义在哪?还是说我成了那种“谁需要语法高亮啊”的怪人?
bananabill查看英文原文
I think I may be missing the main usecase here but how come I see so many different markdown editors on here all the time? Markdown is pretty simple and easy to read in plaintext, or with simple highlighting so what's the point? Or am I just being one of those weirdos that's like "WHO NEEDS SYNTAX HIGHLIGHTING YOU SCRUBS!"?
选写作工具前先弄清收费和版本迁移政策,别让写作流程绑在不确定的产品上。
如果作者看到:我注意到它现在免费且处于 Beta。想问预期定价是多少,以及从 beta 客户端到付费版怎么过渡?比如我能不能一直留在 beta 版,只有想升级新功能时才付费?到目前为止看着很不错!
cloverich查看英文原文
If creator reads this: I note that its currently free and in Beta. What is the expected cost, and the transition from a beta client to the paid one? e.g. can I just stay on beta forever and only pay if I want to upgrade to get the new features? etc. Looks very nice so far!
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选