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

    技术写作与文档2022niemanlab.org

    为韦布望远镜照片撰写替代文本的科学家访谈

    Interview with the scientist who’s writing the Webb photos alt text

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

    导读

    这是 Nieman Lab 对一位科学家的访谈:她负责为詹姆斯·韦布空间望远镜拍下的照片撰写替代文本(alt text),把人类从未见过的宇宙图像转成文字。对写作者来说,这是一个极好的练习:如何在看不见图像的前提下,用文字准确传达信息与感受,并兼顾不同读者与无障碍需求。评论还顺带讨论了术语选择的问题,也值得思考。

    关键词 无障碍写作替代文本科普写作用词选择

    可以直接用的写作要点

    1. 01

      为图片写替代文本时,先问“读者需要知道什么才能获得同等信息”,再动笔,不要把画面里的每个细节都罗列一遍。

    2. 02

      面对陌生或超出日常经验的事物(如天文照片),要用读者已有的经验做类比,并交代尺度与背景,否则形容词再华丽也是空的。

    3. 03

      面向公众写作时,慎用行业内部术语;像“alt text”这样的缩写在专业圈通用,对普通读者却可能完全陌生,必要时先解释再使用。

    4. 04

      把“描述”与“解读”分开:先说画面上有什么,再说明它意味着什么,读者才能自己判断。

    HN 评论精选

    术语要按读者选:面向客户或外行时,用更直白的说法代替圈内缩写。

    “alt text”这个说法是普通人能懂的俗语吗?我在跟客户交流时一般说“text alternatives”(文本替代方案)。它其实是一个具体的属性,将来也可能被 `aria-label` 之类的取代。

    curlftpfs查看英文原文

    Is "alt text" a colloquialism understood by laymen? I typically use the term "text alternatives" when speaking with clients. It's a specific attribute, it might be supplanted by `aria-label`, etc https://www.w3.org/WAI/WCAG21/Understanding/conformance#text-alternatives

    同类还值得读

    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

    关注向阳乔木

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

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

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