技术写作与文档2017expeditedssl.com
用大白话讲清楚 AWS(2015)
Amazon Web Services in Plain English (2015)
导读
这篇是 2015 年的 AWS 服务“大白话”词典,用类比和轻微幽默解释一串晦涩的云服务名称。对写作者的价值在于:它示范了如何把技术黑话翻译给外行,也暴露了通俗化写作中幽默、类比与准确性之间的取舍。文章较旧,未覆盖 AWS 后来新增的服务。
可以直接用的写作要点
- 01
先给服务一个朴素准确的功能标签,再用读者熟悉的类比展开,别让类比替代定义。
- 02
幽默能降低阅读门槛,但一旦挡住机制解释,就应删掉笑点、补上“是什么、怎么运作”。
- 03
面向外行时,优先回答“它能做什么、和别的服务有什么关系”,而不是堆缩写和产品名。
- 04
类比要标出边界:用 FTP 帮助理解 S3 可以,但直接称其为 FTP 会误导。
HN 评论精选
解释性写作要肯为清晰牺牲笑点,并持续补充深度。
作者自述:这篇较旧,未补新服务;幽默引发争议,最初只是朋友间拿晦涩名字开玩笑。他做过实质修改,删掉一些搞笑句子以更好解释服务是什么、怎么运作;也把部分服务扩写成更深入文章,并曾考虑做成电子书。
michaelbuckbee查看英文原文
Hey, Author here. This is old and I haven't added some of the new services that AWS has released since I first wrote it. Whenever this list comes up there's generally a group of people that dislike it for trying to be at least mildly humorous (The whole concept for it started with my developer friends and I joking about some of the names and how opaque they were, so not sure what I'm supposed to do). There were a couple substantial edits I made to it where a few funny lines were cut in favor of better explaining what/how something worked. I also started fleshing out some of the services with slightly more in-depth articles about them (such as this discussion of AWS Buckets where I compare Amazon's CTO to a character from 28 Days Later - https://www.expeditedssl.com/aws-s3-buckets-of-objects I've sometimes thought that I should try and make it into an ebook or something, but there's always been something more interesting to work on. Thanks to everyone who has enjoyed it, shared it with their friends and hopefully took their first steps to messing around with AWS.
外行读者需要平实解释,也会顺着熟悉框架寻找类比。
对不熟悉 AWS 的外行很有用;想知道 Azure 有没有类似内容,尤其想弄懂不同 App Service 的区别及其与 Visual Studio 项目模板的关系。
dcw303查看英文原文
This is really useful for a layman like me who doesn't have a lot of exposure to AWS. Anything similiar for Azure? I would really like to understand the difference between the different types of app services, and especially how they relate to the project templates in Visual Studio.
类比标签要准确,不能用近似概念替代定义。
把 S3 叫“FTP”有点误导;我会叫它“文件存储”,再按 FTP 的思路解释。
beefsack查看英文原文
Calling S3 "FTP" is a bit misleading, I would have just called it "File Storage" and explained it along the lines of FTP instead.
晦涩命名会遮蔽功能,通俗解释能帮读者发现服务价值。
正因为名字晦涩,我才发现 AWS 有一堆我不知道的东西;最惊讶的是 Elastic Beanstalk 竟是 PaaS。
pyreal查看英文原文
I just discovered a bunch of interesting stuff that I had no idea AWS provided thanks to the cryptic names. Most notable is Elastic Beanstalk - had no idea that was a PaaS!
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选