HN 写作课

工程师们二十年里聊过的写作。

工程师、作家、编辑和创业者在 Hacker News 上聊了二十年“怎么写”:怎么写得清楚、怎么讲好一个故事、技术文档怎么写、小说和出版是怎么回事。这里把其中关于写作与讲故事的帖子挑出来,配上中文导读、可以直接用的写作要点和评论翻译。

从必读开始
  • 2,600+篇关于写作的 HN 讨论

Writing tips

写作锦囊

正在抽一条写作要点…

Essential

必读 30 篇

在讨论库里看全部精选

编辑精选里 HN 讨论最热的 30 篇,每篇都有中文导读和写作要点。

  1. 正在载入…

Archive

讨论库

按发帖年份分布,点柱子筛选。

排序

    About

    这些讨论是怎么挑出来的

    1. 01

      从全量里捞

      读取 Hacker News 自 2006 年以来的全部帖子,用关键词先捞出 40 分以上、可能和写作有关的约 1.1 万篇。

    2. 02

      只留真正讲写作的

      由 AI 逐条判断是否和写作、讲故事、文风、出版有实质关系,剔除“写代码”“编辑器”这类字面撞车,并分进十个类别。

    3. 03

      提炼可用的要点

      为值得读的帖子写中文导读,提炼 2-4 条可以直接用到自己写作里的要点,并精选翻译 HN 高赞评论。内容由 AI 生成,可能有误。

    技术写作与文档2015tex.s2cms.ru

    Markdown 与 LaTeX 编辑器

    Markdown and LaTeX Editor

    阅读原文 HN 讨论
    172HN 得分
    61条评论
    4条写作要点

    导读

    这是一个支持 Markdown 与 LaTeX 混排的在线编辑器页面,评论区里读者分享同类工具和各自的使用经验。对写作者而言值得留意的是“用纯文本标记语言写作、再输出成网页、电子书或 PDF”这条工作流,以及不同写作者在“标记语言 vs 富文本”之间的偏好差异。

    关键词 MarkdownLaTeX写作工具排版

    可以直接用的写作要点

    1. 01

      用 Markdown 写正文、用 LaTeX 插入公式,可以在同一份纯文本里兼顾易读的写作格式与专业的数学排版。

    2. 02

      同一份源文件能同时输出网页和电子书,像 Softcover 那样让代码密集、公式密集的长文维护成本大幅降低。

    3. 03

      选工具前先想清楚自己属于哪类写作者:愿意写标记语言的,还是希望完全不碰代码、用富文本的。

    4. 04

      优先选能在本地离线运行的编辑器,别让网络连接成为写作的额外阻碍。

    HN 评论精选

    支持 LaTeX 的 Markdown 工具不止一个,值得比较一圈再定。

    还可以看看 rMarkdown(http://rmarkdown.rstudio.com/),它支持在 Markdown 中嵌入 LaTeX(还有一堆其他功能),配套的实时编辑器是 editR。想要更长的清单和讨论,可以看这个 hackpad 页面(其中也收录了 stackedit.io)。

    stared查看英文原文

    See also rMarkdown (http://rmarkdown.rstudio.com/) for Markdown supporting LaTeX (and bunch of other things) and its real-time editor editR (https://github.com/swarm-lab/editR). Or for a longer list/discussion: https://hackpad.com/New-scientific-markup-language-utAjFcYuvvB (it includes https://stackedit.io/).

    同一套 Markdown+LaTeX 源文件能撑起代码密集和公式密集两类书稿。

    Softcover 可以在本地(无需联网)用普通文本编辑器和浏览器处理 Markdown 加内嵌 LaTeX。我用 Softcover 写作并维护两本书:代码密集的《Ruby on Rails Tutorial》和数学密集的《Tau Manifesto》。(利益披露:我也是 Softcover 的主要作者。)

    mhartl查看英文原文

    Softcover handles Markdown + embedded LaTeX on your local machine (no 'net connection required) using a standard text editor and web browser: http://softcover.io/ I use Softcover to write and maintain both the code-heavy Ruby on Rails Tutorial (http://railstutorial.org/book) and the math-heavy Tau Manifesto (http://tauday.com/tau-manifesto). (Disclosure: I'm also the principal author of Softcover.)

    写作者在“标记语言”和“富文本”之间明显分成两派。

    我很好奇这里有多少人经常用 Markdown?我是 Overleaf 的创始人之一,我们发现用户大致分两类:一类希望用完整的 LaTeX 编辑,另一类连 Markdown 里的代码都不想写(所以我们给 Overleaf 做了富文本层)。如果你常用 Markdown,它多久能满足你全部需要、多久得换别的工具?欢迎反馈。

    JohnHammersley查看英文原文

    I'm curious as to the percentage of users here that use Markdown regularly? I'm one of the founders of Overleaf, and we've found that our users tend to either want to be able to edit in full LaTeX or want to avoid the need to code even in markdown (hence the reason we built a rich text layer for overleaf[1]) If you do use Markdown regularly, how often does it allow you to do everything you need (i.e. how often do you have to switch to something else)? Feedback appreciated, thanks. [1] https://www.overleaf.com/blog/81

    同类还值得读

    1. 编写更好文档的框架

      A Framework for Writing Better Documentation

      这是 Divio 的文档写作框架,把技术文档按「读者的目标」分成四类:教程(学习导向)、操作指南(问题导向)、参考(信息导向)、解释(理解导向)。

      技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选
    2. 写好一份设计文档

      Writing a good design document

      这篇 HN 帖子标题为《Writing a good design document》,主题是如何写好一份设计文档;对写作者来说,它值得作为技术写作和结构化说明文的参照。

      技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选
    3. 技术写作课程

      Technical Writing Courses

      这是 Google 官方免费技术写作课程(两门),讲受众定义、主动语态、短句、文档结构等基础方法。

      技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选
    4. 写出更好的错误信息

      Write better error messages

      这篇帖子讨论如何写出更好的错误信息,评论补充了开发者场景下的具体做法和真实反面案例。

      技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选
    5. 写一本技术书的经济账

      The Economics of Writing a Technical Book

      一位技术书作者拆解写书的真实经济账:版税收入往往远低于投入的时间成本。

      技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选

    打赏支持

    打赏二维码

    觉得有用,请作者喝杯咖啡。

    WeChat

    关注向阳乔木

    微信公众号「向阳乔木推荐看」

    微信公众号「向阳乔木推荐看」二维码

    微信扫一扫;在微信里打开本页时,长按二维码识别。