思考与写作developers.google.com编辑精选
技术写作课程
Technical Writing Courses
2020 — 2022，它一次次回到首页
黑点是上首页（≥ 50 分）的那次投稿，空心点是没冲上去的投稿，点越大分数越高。
导读
这是 Google 开发的免费技术写作课程页面，包含两门模块化课程，涵盖明确受众、使用主动语态、写短句等核心写作原则。课程结构清晰，每节课都有大纲和目录，适合工程师和写作者自学。
为什么经久不衰：它把技术写作的关键原则整理成免费、结构清晰的课程，多年来被反复推荐，是提升文档写作能力的快速入门资源。
HN 评论精选
课程结构清晰、内容扎实，值得认真看再评价
看完评论区，我怀疑很多人根本没点开链接看内容。这两门课程结构很好，每门课有整体大纲，每节课有目录。课程用易于内化的原则讲解了技术写作的关键主题，比如定义受众、吸引受众、短句如何提升理解。我上大学时要是能有这么清晰的课程就好了。
mattlutze查看英文原文
After reading some of the comments here, I'm wondering if people are actually following the link and reviewing the content. The two courses are well-structured. Each course has an overall outline listing each lesson, and each lesson has a table of contents to overview the topics therein. The courses highlight major key topics in technical writing and does so with easy-to-internalize (tenets). I'd have loved for my university coursework to be so clearly organized. Some highlights include defining your audience[1], engaging your audience[2] and reviewing how short and clear sentences improve comprehension[3]. 1: https://developers.google.com/tech-writing/one/audience#define_your_audience 2: https://developers.google.com/tech-writing/one/active-voice 3: https://developers.google.com/tech-writing/one/short-sentences
推荐《经济学人》和美军写作指南作为补充资源
我见过最好的是《经济学人》风格指南，美国陆军的领导力写作风格指南也很不错。这里的示例也非常好。
sandGorgon查看英文原文
The best i have seen is the economist style guide - http://cdn.static-economist.com/sites/default/files/pdfs/style_guide_12.pdf the US Army writing style guide for leadership is also pretty good - https://www.esd.whs.mil/Portals/54/Documents/DD/iss_process/Writing_Style_Guide.pdf The examples here are very very good.
课程偏基础，但让人更重视插图；推荐 divio 文档模型
我之前学过这两个模块，花不了多久。模块一对我来说没什么价值，基础得让我吃惊。模块二还行。这些课程给我留下的持久改变是更重视在插图上投入时间精力。我觉得其他资源（如 jacobian、I'd rather be writing）对我更有帮助。我很喜欢 divio 的文档模型——先就文档的目的达成一致是解决问题的大头。我还常看到一种适得其反的倾向：领域专家写文档时进入 ELI5 模式，把操作指南写成了教程。
CraigJPerry查看英文原文
A while back i took both modules, they don’t take long to go through. Module 1 wasn’t any value to me, it felt far far too basic, i was really caught off guard by how basic it is. Module 2 was ok-ish. The lasting change these courses left in me was more appreciation for investing time and effort into illustrations. I found other resources to be more impactful for me personally (e.g. jacobian / i’d rather be writing). I liked this model https://documentation.divio.com/ - agreeing with people what purpose the docs they’re writing are for is a big chunk of the problem surface area. Having a model makes life easier. I’m not sure it has to be this exact model but this one seems good enough to me. A counterproductive tendency I’ve observed frequently is when an SME is tasked with documenting their thing and they go off in ELI5 mode. So tutorial instead of how-to per the above model. Having that model helps keep those conversations short and productive.
技术写作者职业处境艰难，作者本人转行做了开发
我15年前英语专业技术写作方向毕业，做了几年这行，说实话很糟糕。开发者把我当傻子，我总在开发周期末尾才介入，没时间做好工作，管理层还分不清我是测试还是写作。我干脆自学转行做了软件开发，十年从未后悔。现在有人请我写文档我很乐意——只是不把它当主业。
breckenedge查看英文原文
I graduated with a BA in English with a Technical Writing concentration 15 years ago. I did the job for a few years and, honestly, it sucked. At best, I was treated like an idiot by developers. Developer aloofness seemed much worse back then — they were never wrong. I was always at the end of the software development cycle, so there was never enough time budgeted to do good work. Management couldn’t decide if I was a tester and a writer, so I often had to fill both roles. The rapid nature of software development today is great for users and developers, but lends itself to rapidly expiring documentation. I did the job long enough to teach myself software development. I switched over to being a software dev ten years ago and have never regretted it. Entry level pay as a software dev was better than experienced pay as a technical writer. I have been asked to write documentation, and I’m glad to do it — just not as my primary duty.
历次讨论
同类还值得读
保持你的身份认同足够小
Keep Your Identity Small (2009)
Paul Graham 2009 年的一篇短文：人一旦把某个话题当成自己身份的一部分（宗教、政治、编程语言皆然），讨论就会退化成站队和争吵，因为此时争论的不再是事实，而是"我是谁…
思考与写作上首页 5 次 · 2009–2021paulgraham.com编辑精选苏格拉底式教学法：通过提问而非讲授来教学
The Socratic Method: Teaching by Asking Instead of by Telling
记录了作者用纯提问的方式，引导一群小学生从零推导出二进制计数法的课堂实验，展示了苏格拉底式教学法的惊人效果。
思考与写作上首页 5 次 · 2011–2022garlikov.com你不能说的话
What You Can't Say (2004)
Paul Graham 2004 年的经典文章，探讨那些因道德时尚而不能公开说出的观点。
思考与写作上首页 5 次 · 2014–2022paulgraham.com编辑精选龙暴君的寓言（2005）
The Fable of the Dragon-Tyrant (2005)
哲学家 Nick Bostrom 于 2005 年写的一则寓言：一条每天吞噬数千人的巨龙（隐喻死亡与衰老）长期被人类当作不可抗拒的自然规律接受，直到有人提出并最终用导弹将其杀死，…
思考与写作上首页 5 次 · 2009–2021nickbostrom.com编辑精选现实有着惊人的细节量
Reality has a surprising amount of detail (2017)
2017 年的博文指出，现实远比我们以为的充满细节：我们习惯用简化的心智模型看世界，直到真正动手做事（比如作者举的造楼梯例子）才发现处处是未曾预料的细节。
思考与写作上首页 4 次 · 2018–2025johnsalvatier.org编辑精选