技术写作与文档2021web3us.com
用大白话解释 AWS(2019)
Amazon Web Services In Plain English (2019)
导读
这篇帖子是一份把 AWS 服务名翻译成大白话的对照表,评论区围绕这种简化命名是否准确展开争论。对写作者而言,它提醒我们:解释复杂概念时,通俗化和准确性要同时兼顾。
可以直接用的写作要点
- 01
给术语起“大白话别名”时,最好同时标注它覆盖和不覆盖的功能,避免读者把类比当成定义。
- 02
概括一个概念时,用能涵盖其完整用途的名称,而不是只描述最常见的一个场景。
- 03
首次引入缩写或行业黑话时,先展开全称,并用一句话说明它解决什么问题。
- 04
可采用“原名 + 大白话解释 + 边界说明/例子”的三段式,让解释既易懂又不失真。
HN 评论精选
过度简化的改名会丢失功能边界,解释概念要保留全貌。
我不喜欢这些改名:所谓“简化”常常砍掉主要功能。原名至少能让人联想到整套能力。比如 IAM 改成“用户、密钥和证书”,却漏掉角色、权限和策略这个核心;S3 叫“无限 FTP 服务器”会让人以为它遵循 FTP 协议;Lambda 叫“脚本”也不对,它能支撑整个无服务器架构甚至整站;Cognito 不只是 OAuth,也存普通账号;SNS 不只会发消息,还能触发 Lambda。
hn_throwaway_99查看英文原文
The problem I have with these renamed is that by "simplifying" the name, they often cut out major pieces of functionality. The original names are at least "brandable" so that when I think of that name, I think of the entire suite of functionality. Some examples: 1. IAM -> Users, Keys and Certs. But other commenters have already pointed out this leaves out the whole roles, permissioning and policies that is really the core of IAM. 2. S3 -> Amazon Unlimited FTP Server would imply to me that S3 actually just follows the FTP protocol, which is totally false. 3. Lambda -> AWS App Scripts. I have news for the author, but I know some companies and architectures that use Lambda as a basis for an entire serverless infrastructure, a heck of a lot more than "little scripts", e.g. serving whole websites. 4. Cognito -> Amazon OAuth as a Service - except many companies use it to store plain user accounts (e.g. username and password), not just setting up OAuth for accounts managed elsewhere. 5. SNS -> Amazon Messenger. But SNS can be used for a lot more than just sending emails, texts or push notifications. For example, it can be used to trigger lambdas. "Notification Service" seems to much better encompass the generic nature of the notification handling that SNS provides.
专业原名可能比简化别名更准确,不能因不喜欢缩写而否定它。
有人说 IAM 应叫“用户、密钥和证书”,这很好笑:我们有数百名开发者每天用 AWS、一直用 IAM,却从没用过 IAM User。IAM 这个名字其实极好——Identity and Access Management,我想不出更好的。如果你只是不喜欢缩写,那可能入错行了。
adambatkin查看英文原文
IAM "Should have been called Users, Keys and Certs" That's funny. Because we have hundreds of developers using AWS every day, using IAM all the time, and never using a single IAM User. IAM is actually named extremely well. identity and Access Management. I can't think of a better name. And if your problem is that you just don't like acronyms, you probably picked the wrong industry.
缩写若不展开含义,对不熟悉生态的读者就是黑话,解释时应主动拆解。
有些命名明显是在故意绕弯。我要处理队列,该用什么?当然是 Amazon SQS。那是什么?队列服务。那为什么叫 SQS?Simple Queue Service 呗。还有更复杂的队列服务吗?没有,只有 SQS。这个缩写完全没用,除了说明它和队列有关,对圈外人什么也没解释清楚。
Traster查看英文原文
Some of these are clearly deliberate obfuscation. I need something to handle Queues, what should I use? Amazon SQS obviously. Oh cool, what’s that? It’s a Queue service! Oh great, why is called SQS? Simple Queue Service duh! Is there a more complex queuing service? No. There’s only SQS. The acronym is totally useless, tells you nothing beyond it being for Queues and completely obfuscates what’s happening for anyone not in the eco system.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选