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 生成,可能有误。

    技术写作与文档2014paperman.patricklorio.com

    Show HN:Paperman——带 Markdown 手感的 LaTeX 编辑器

    Show HN: Paperman – LaTeX editor with a Markdown feel

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

    导读

    这是一个把 Markdown 的轻量与 LaTeX 的公式排版结合起来的在线编辑器,评论主要围绕「它到底算不算 LaTeX 编辑器」以及 Markdown 转 LaTeX 的实用工作流展开。对写作者来说,它提供了一个关于工具定位与写作流程的对照:什么时候该留在纯文本里,什么时候才需要更重的排版系统。

    关键词 MarkdownLaTeX写作工具排版

    可以直接用的写作要点

    1. 01

      标题和定位要诚实:把「Markdown 编辑器 + 内联公式」说成「LaTeX 编辑器」,会让读者一上手就失望,写作中的承诺与内容必须对得上。

    2. 02

      需要产出排版精美的长文时,可以用 Pandoc 把 Markdown(含内联公式、表格等扩展)转成 LaTeX 再转 PDF,一条命令走完全流程。

    3. 03

      公式用 $...$ 内联写在行文里,独立成行的公式才另起环境,别把两者混用,读者才能顺畅地跟着你的推导走。

    4. 04

      表格这类强结构化内容,是少数值得离开纯文本输入、改用可视化编辑的场景;其余部分尽量保持纯文本,便于版本管理和迁移。

    HN 评论精选

    工具命名与实际能力不符,会让用户按错误预期使用。

    我试着输入一对 \begin{equation} 想得到编号公式,结果什么也没发生。我更愿意把它叫作「带 LaTeX 内联公式的 Markdown 编辑器」,而不是 LaTeX 编辑器——最基本的 LaTeX 语法似乎都不工作。(另外,$$ 不是应该用于独立公式,而不是把行内公式放大到 \displaystyle 吗?)

    misnome查看英文原文

    I tried a "\begin{equation}" pair to get a numbered equation and nothing happened. I would say "Markdown editor with latex inline equations" instead of calling this a latex editor - the most basic latex syntax doesn't seem to work! (also: Isn't $$ an out-of-line equation, rather than a \displaystyle-sized inline)

    Pandoc 的 Markdown→LaTeX→PDF 链路是轻量写作到正式排版的一条成熟路径。

    想从 Markdown 生成 LaTeX,可以用 Pandoc。Pandoc 为普通 Markdown 增加了多种扩展(包括内联数学、表格等),产出复杂文档时更灵活。事实上,当你选择 PDF 输出时,Pandoc 就是先由 Markdown 转成 LaTeX 再转 PDF。

    wall_words查看英文原文

    If you want to generate LaTeX from Markdown, you can use Pandoc. Pandoc has various extensions to regular Markdown (including inline math, tables, etc.), so this gives you some flexibility when producing more complicated types of documents. In fact, Pandoc converts from Markdown to LaTeX to PDF when you choose PDF as the output format.

    除表格外都应坚持纯文本输入,模板与云同步才是付费价值点。

    要让我真正用起来,至少还需要:有序列表、下载 LaTeX 源码。我愿意付费的功能是:好用的表格编辑器(我认为这是唯一值得偏离纯文本输入的地方)、加载 LaTeX 模板并支持常用宏包,好让我直接在线写论文、与 Dropbox 和/或 Google Drive 集成。

    m_mueller查看英文原文

    Here's what I'd need as a minimum to make productive use of this: * numbered list * download LaTeX What I'd consider paying for: * a nice table editor - IMO this is the only case where it would make sense to divert from the text-input-only approach. * Load LaTeX templates, have all of the common packages supported, so that I could just write papers online. * Integration with DropBox and/or Google Drive

    同类还值得读

    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

    关注向阳乔木

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

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

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