Refactoring English

RSS: https://refactoringenglish.com/index.xml
面向软件开发者的有效写作指南。

如何写一份有效的软件设计文档

<p>一份优秀的设计文档可以为你节省数年的开发时间。撰写设计文档迫使你在投入错误的实现方案之前,先深入思考并权衡各项重要决策。<br><br>同时,这也是在团队内部及与其他合作团队之间协调设计决策的最佳方式。</p><p>我曾在谷歌、微软以及 担任开发人员,期间撰写过大量设计文档。虽然具体形式各有不同,但其核心原则始终如一:设计文档清晰地阐述了你正在解决的棘手问题,并有助于团队成员为你提供反馈。</p>
评论点赞收藏16 天前

我不再做“内容创作者”了

作者反思“内容创作者”这一商业术语对创作心态的异化,主张用“作者”、“博主”等具体身份替代“内容”这种去人格化的词汇。他认为语言选择直接影响对待读者的态度:称访客为“流量”会让人变得功利,而称为“读者”则能唤起对真实个体的尊重。 文章结合个人创业经历与比尔·盖茨“内容为王”的历史背景,探讨如何通过重构语言来找回创作的初心与尊严。
评论点赞收藏72 天前

我为何停止“制造内容”

<p>我第一次亲眼见到米开朗基罗的《大卫》时,不禁落泪。我一生中从未见过如此美妙的作品。</p><p>并非只有我这样觉得。我身边所有的博物馆参观者也都纷纷抬起头,从手机上移开目光,凝视着《大卫》。尽管这是一件经典之作,但其魅力却令人目不转睛、深深着迷,甚至比TikTok和Instagram加起来的互动量还要高——尽管这些平台提供的内容往往更新鲜、更贴近个人需求。</p>
评论点赞收藏72 天前

如何撰写高效软件设计文档

作者基于在Google、Microsoft及创业经历,总结了一套设计文档(Design Doc)的实战方法论。核心观点是按“犯错成本”决定文档深度,而非一刀切。 详细拆解了从元数据、目标、非目标到SLO监控等组件写法,并附带一个从零编写的完整示例。对于需要协调多人协作、处理复杂系统或跨团队沟通的工程管理者和技术负责人,这是极具操作性的避坑指南。
评论点赞收藏95 天前

博客编辑示例笔记

<p>下面的笔记是我的对于泰勒·奇普里亚尼文章的初稿, 我与泰勒合作:</p><p>• 更清晰地了解目标受众</p><p>• 将文章重点放在读者可以应用的实用教训上</p><p>• 找到一个清晰且直观的结构</p><p>泰勒完成的文章获得了强烈的积极评价:</p><p>• 抵达获得550+点赞</p><p>• 抵达 • 抵达 哪些地方效果不错</p><p>广泛相关的话题</p><p>我喜欢这个话题,因为它对大量开发者都很相关,尤其是在像Hacker News这样的地方。</p>
评论点赞收藏125 天前

哪个设计文档是人类写的?

I created three design docs for the same open-source web app: • I spent 16 hours writing one of the design docs completely by hand. • I generated one using Claude Opus 4.6 (medium effort). • I gene...
评论点赞收藏189 天前

为什么要提升写作能力?

I’ve worked as a developer for 20 years, and I’ve always cared about clear writing. When I join a new dev team, the first thing I do is ask to update their onboarding docs. I capture what I learn in w...
评论点赞收藏211 天前

2025年Hacker News最受欢迎的博客

With 2025 wrapped up, I can finally answer a question I’m curious about every year: who were the most popular bloggers of Hacker News? Who counts as a blogger? I explain more in my methodology page,...
评论点赞收藏271 天前

如何在设计文档上获得有意义的反馈

You’ve spent weeks carefully writing a design document for your software project, but what happens next? How can you get useful feedback about it from your teammates? How do you prevent your design re...
评论点赞收藏331 天前

塑造我的软件散文

I started reading software blogs before I got my first programming job 20 years ago. At this point, I’ve read thousands of blog posts and essays about software, but only a small handful stuck in my mi...
评论点赞收藏365 天前

为软件开发人员有效写作

《Refactoring English》是一本针对软件开发者的写作指南,旨在帮助开发者提升技术文档、教程、博客文章和电子邮件等领域的写作技巧。 书中涵盖了许多实用建议,如如何简洁明了地表达观点、如何让写作听起来自然、如何减少读者的认知负担等。通过学习和应用这些最佳实践,开发者可以显著改善他们的写作能力,从而更好地传达信息并提高沟通效率。 本书目前处于早期访问阶段,订阅者将收到更新和章节预览。
评论点赞收藏397 天前

关于我的章节列表的读者反馈

For the past eight months, I’ve been working on my book, Refactoring English: Effective Writing for Software Developers. I’m publishing the book incrementally as I write, which means readers give me f...
评论点赞收藏397 天前

如何撰写引人注目的软件发布公告

A release announcement showcases how the user’s experience is better today than it was yesterday. That sounds obvious, but most release announcements seem to forget that there’s a user at all. So man...
评论点赞收藏462 天前

如何写出开发者愿意阅读的博客文章

本文是一位拥有九年博客写作经验的软件开发者撰写的实用指南,旨在帮助开发者写出更吸引人的技术博客文章。作者通过自身经历和成功案例(如文章在 Hacker News 多次登顶、Reddit 和 Lobsters 的高曝光),总结了提高博客吸引力的关键技巧:包括快速切入主题、扩大受众范围、规划读者获取路径、增加图片辅助理解、适应浏览者速读习惯等。 文章强调,避免冗长铺垫,使用易懂术语,提供明确价值,并借助视觉元素提升可读性,是吸引读者的核心策略。
评论点赞收藏551 天前

Hacker News 上排名最高的个人博客

本文列出了 Hacker News 上排名最高的个人博客,包括 Paul Graham、Brian Krebs、Simon Willison 等知名作者。文章提供了每个博客的总得分、故事数量、平均得分以及主题领域,涵盖了从创业、安全、AI 到技术分析和计算机科学等多个领域。 这些博客因其高质量的内容和影响力在 Hacker News 社区中获得了极高的评分。
评论点赞收藏554 天前

HN人气竞赛:什么才算个人博客?

What counts as a personal blog? • I count a site as a personal blog if: • the site contains written content (not just an app or a video) • the site is authored by a single person • A blog still co...
评论点赞收藏566 天前

被动语态有害论

Your high school English teachers probably warned you that passive voice is dangerous and forbidden. Then, when you were an adult, some guy in a leather jacket told you that passive voice is cool and ...
评论点赞收藏607 天前

登录芦苇

登录后关注作者、收藏内容和参与讨论。