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

    写作方法2021kevinwmcconnell.com编辑精选

    我是如何写出我的书的

    How I Wrote My Book

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

    导读

    作者凯文·麦康奈尔讲述自己写书的技术流程:他从 Markdown 起步,但很快发现 Markdown 自带的语法和能力不够用,于是自己补上工具,最终搭出一套能完成整本书的写作流程。对写作者来说,这篇值得读的地方不只是工具清单,更在于它展示了「先让文字顺畅地流出来,再处理格式」这一取舍:当格式成了阻力,你该动手改工具,而不是改写作习惯。

    关键词 Markdown写作工具写作流程排版

    可以直接用的写作要点

    1. 01

      动笔阶段尽量用纯文本或 Markdown,把排版和格式留到定稿前统一处理,别让调格式打断思路。

    2. 02

      提前想清楚一本书里 Markdown 做不到的东西——脚注、交叉引用、图表、编号——要么找现成工具,要么自己补,不要写到一半才处理。

    3. 03

      把写作流程当成可以打磨的技术环节:构建步骤越少,越容易坐下来继续写。

    4. 04

      用 Vale 这类文体检查工具捕捉口头禅、重复句式和拼写错误,让编辑精力留给结构和论证。

    HN 评论精选

    选带「零构建」特性的 Markdown 变体,源码保持简单,渲染照样漂亮。

    我参与合编 Peter Shirley 的《Ray Tracing in One Weekend》,做法类似,但工具不同。我们用 Markdeep——一个功能很强的 Markdown 实现:只要在文件开头写几行 UTF-8 声明、结尾挂一个 JS 加载器,它就会在浏览器里自动转成完整的 HTML 文档。这就省掉了构建步骤,还能叠加 CSS;它内置 LaTeX 引擎和 ASCII 图渲染。你可以看看那三本光线追踪书的源码有多简单、成品有多好看。

    hollasch查看英文原文

    Very cool. I co-edit Peter Shirley's _Ray Tracing in One Weekend_ (https://raytracing.github.io/) and have taken a similar approach, though with a different toolset. At some point if I find the time, I'll write up a similar article on our approach and what we've learned. Our books are open-sourced on GitHub (https://github.com/raytracing/raytracing.github.io), and we also use GitHub to host our books. Basically, we use Markdeep (https://casual-effects.com/markdeep/), a _very_ powerful Markdown implementation with a bunch of built-in features. The killer feature is that with a handful of boilerplate lines (UTF-8 declaration at the top, and JavaScript loader at the bottom), you get content that automatically self-transforms in the browser into a full HTML document. This eliminates any build step, and means you can treat it as you would any other HTML file, with optional CSS and other features. It also bundles in a LaTeX engine, ASCII diagram rendering, and a whole host of other features. If you look at the three ray tracing books, you can see how simple the source is, and how pleasing the final rendering. Check out the books and the GitHub repo — it's a _great_ way to quickly and easily pound out a web book.

    Pandoc 已能解决大部分从 Markdown 到成书的转换需求,先查现成方案再造工具。

    作者说 Markdown 原生不支持很多写书需要的东西、又找不到能全包的工具,我很意外他没提 Pandoc——它基本能实现作者想要的效果,而且直接吃 Markdown。

    pezzana查看英文原文

    > But when writing a book, pretty soon you run into things that Markdown doesn’t natively know how to do, and so you have to either look for extra tooling to fill in the gaps, or build support for those things yourself. There are open source projects that address some of this, but I didn’t see anything that would do everything I needed. I'm surprised there's no mention of Pandoc, which does pretty much what the author wanted (at least at a high level) and works with markdown: https://pandoc.org/epub.html

    用 Vale 这类命令行工具检查行文,把文字层面的低级错误自动化。

    推荐在编辑器里用 Vale 检查行文。它能实现接近 Grammarly 的规则检查,对技术文档的拼写也处理得不错。

    adamgordonbell查看英文原文

    I would recommend using Vale for linting prose in a text editor. It can approach grammarly like rules as well as handling spelling for technical documents fairly well. https://github.com/errata-ai/vale

    Markdown 的「功能少」换来了跨格式可靠,排版务必留到最后。

    Markdown 最大的优点——简单——也是它的局限。但它反过来又还是优点:功能是少,可它有的功能在所有导出格式里都一定支持。格式本来就该放在最后做,提前做只是干扰。我写学术论文时通常先用 Markdown,到最后一刻才导出 .tex 去处理排版。

    bArray查看英文原文

    > At the end of the day, Markdown’s biggest strength — simplicity — is also its limitation. But also its strength again. It's missing features, sure, but the features it does have you can be very sure exist in all the export formats. Formatting is really something you should be doing at the end, otherwise it's a distraction. I tend to use markdown for the initial writing of academic papers for example, only exporting to LaTeX .tex at the very last minute to address formatting.

    同类还值得读

    1. 被低估的工程技能:把文章写好

      Undervalued Engineering Skills: Writing Well

      这篇文章讨论为什么“写得好”是被低估的工程能力,以及它如何在团队协作、系统设计和职业发展中持续带来回报。

      写作方法2019 · 1,109 分 · 371 评4 条写作要点编辑精选
    2. 每行只写一句话:让写作和修改都更轻松的排版法

      Writing one sentence per line

      这是 Derek Sivers 的一篇短文,主张写作时每行只放一个句子,而不是按段落排版。

      写作方法2022 · 849 分 · 297 评4 条写作要点编辑精选
    3. 书面沟通是远程工作的超级能力

      Written communication is remote work super power

      这篇文章讨论远程工作中书面沟通的价值,评论区则补充了异步与同步沟通的适用场景,并提醒读者:备忘录、结论先行、结构化命令格式等书面沟通传统早已有之。

      写作方法2020 · 831 分 · 190 评4 条写作要点编辑精选
    4. 如何写出有用的文字

      How to Write Usefully

      保罗·格雷厄姆在这篇文章里给"有用的写作"下了一个可操作的公式:有用≈重要×新颖×正确×清楚,任一项为零,整篇文章就等于零;他还主张敢下确定判断、删掉让自己心虚的句子。

      写作方法2020 · 821 分 · 285 评4 条写作要点编辑精选
    5. 如何写得更清楚、想得更清楚,并学会复杂材料(PDF)

      How to write more clearly, think more clearly, and learn complex material [pdf]

      这份 PDF 讨论如何把文章写清楚、把思路理清楚,并用写作来学习复杂材料。

      写作方法2022 · 779 分 · 153 评4 条写作要点编辑精选

    打赏支持

    打赏二维码

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

    WeChat

    关注向阳乔木

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

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

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