技术写作与文档2022nerdleveltech.com编辑精选
技术写作：你需要知道的一切以及如何入行
Technical Writing: All You Need to Know and How to Land a Job
导读
这是 NerdLevelTech 上的一篇技术写作入门文章，内容包括这一行做什么、怎么入行找工作。评论者普遍认为该文信息来自第二手、第三手资料，疑似由 AI 生成，并且有很强的 SEO 文章特征；但它也引出一个更值得写作者思考的问题：真正有价值的技术写作究竟从何而来。对写作者而言，这组讨论的价值在于：读者分享的实操经验比文章本身更有参考价值，包括自己先用好产品、积累真实的困惑和问题、以及深入一线去建立领域专长。
可以直接用的写作要点
- 01
动手使用自己写的东西：在亲身体验中把卡住你的疑问记成清单，然后逐个问明白；这些疑问往往也是读者会有的。
- 02
把自己放到知识产生的地方：工程师写代码、产品经理写需求、支持工程师提 bug 的现场，待得越久，写作的权威性越强。
- 03
不要只做二手的信息拼贴：单纯读资料再转述，容易写成没人需要的“营销式废话”，真实的一手经验才是稀缺内容。
- 04
多读多写没有捷径，这是任何写作方向都绕不开的基本功；在技术写作上，还需要同时积累领域知识和写作习惯。
HN 评论精选
要学技术写作，应选有真实从业经验者写的一手资料，而不是拼凑出来的入门文。
这篇文章看起来是根据第二手、第三手资料写的，而不是作者本人的经验，我也觉得它至少有一部分是 AI 生成的。如果你是想做技术写作的开发者，更推荐 Philip Kiely 的《Writing for Software Developers》：书名像技巧书，其实讲的是写作的商业面，以及怎么接教程和技术演练类的自由撰稿活儿；作者在写这本书之前已有多年专业经验，而本文作者似乎没有。他还维护 Who Pays Technical Writers，报价参考比这篇文里的更可信。
mtlynch查看英文原文
This article seems to be based on second- and third-hand information rather than personal experience. I agree with others that it seems at least partially AI-generated. If you're a software developer interested in working as a technical writer, I think the better resource is Writing for Software Developers by Philip Kiely.[0] The title makes it sound like a book on technique, but it's more about the business of writing and finding freelance jobs writing tutorials and technical walkthroughs. Philip wrote it early in his career, but he had several years of professional experience as a technical writer already, which seems not to be true of OP. Philip also maintains Who Pays Technical Writers,[1] a resource I'd trust for market rates more than any listed in TFA. [0] https://philipkiely.com/wfsd/ [1] https://whopaystechnicalwriters.com/
SEO 流水线式的文章没有辨识度，读者一眼就能看出来。
我试着去读这篇文章，但它读起来和 Google 上搜任何问题都会冒出来的那些 SEO 页面一模一样。
TurkishPoptart查看英文原文
Trying to read TFA but it resemebles every SEO page that comes up with any question-based request submitted to Google.
真正的技术写作靠亲自动手使用产品，再把真实的困惑变成解答。
在我看来，第一位的技能是真的有能力去用你写的那款产品，别只是读读资料就写点东西，你得实际用过它。学习过程中把让你困惑的问题记下来，因为这些问题也会困惑别人；然后再把答案找出来。道理很简单：大多数技术写作都是营销垃圾，而且很容易识别。这个世界被 SEO 文章淹没了，而技术人员极度缺乏真正的技术内容。我在这行干过，薪酬可以很不错，做得好的话能有那篇博客里说的三倍以上，职位名通常是 technical writer 或 technical marketing engineer。
WestCoastJustin查看英文原文
For me, the #1 skill here is having technical ability to actually use the product you're writing about. Like, don't just read about the product and do some write up -- you need to actually use it. Keep a list of questions or things that confuse you while learning since these will confuse other people too -- get answers to those questions. The reason, sounds so simple, is that most technical writing is marketing crap. It's easy to spot too. We live in a world that is flooded with SEO articles and technical people are starved for real technical content. I have worked in this field and that's my experience. Here's my website https://sysadmincasts.com/ as proof. I work at a tech company and write blogs, create demo videos, and stuff like that for a very technical product. Happy to answer any questions. Also, comp can be pretty good like 3x+ what that are talking about in that blog if you are good. The job postings for this are normally something like "technical writer" or "technical marketing engineer".
多读多写，并进入知识产生的一线现场，写作才有权威性。
用斯蒂芬·金的话来简化这个建议：想当作家，最重要的是多读和多写，没有捷径。要建立领域专长，就让自己待在知识产生的地方：技术写作就是去工程师写代码、产品经理写功能规格、支持工程师提交 bug 和改进建议的地方。你越深入地参与其中，你的写作就越有权威性。
thenerdhead查看英文原文
To simplify this advice: “If you want to be a writer, you must do two things above all others: read a lot and write a lot. There's no way around these two things that I'm aware of, no shortcut.” -Stephen King To build domain expertise, embed yourself wherever that knowledge is. For technical writing that's where engineers are writing code, product managers are creating functional specs, and support engineers are filing bugs/enhancements. The more embedded you are, the bigger an authority you become with your writing.
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架，把技术文档按「读者的目标」分成四类：教程（学习导向）、操作指南（问题导向）、参考（信息导向）、解释（理解导向）。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》，主题是如何写好一份设计文档；对写作者来说，它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程（两门），讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息，评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账：版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选