发布于 2026-01-06 4 阅读
0

成为一名技术作家:3 位工程师的首次社区教程之旅 DEV 的全球展示与讲述挑战赛,由 Mux 呈现:推介你的项目!

成为技术撰稿人:三位工程师的首次社区教程之旅

由 Mux 主办的 DEV 全球展示挑战赛:展示你的项目!

DigitalOcean 社区教程的忠实读者(例如《如何在 Ubuntu 18.04 上使用 Let's Encrypt 保护 Apache 服务器》《如何使用 DigitalOcean Droplets 启动 Hadoop 集群》)可能已经注意到,除了设置说明之外,教程中通常还包含来自实际生产场景的见解、技巧和痛点。这是因为许多教程是由 DevOps 工程师、系统管理员和软件开发人员撰写的,他们渴望分享在实际部署软件和系统过程中遇到的问题的解决方案和变通方法。

DigitalOcean 的作者们通过撰写教程,将他们丰富的实践经验分享给更广泛的开发者社区,同时也巩固了他们自身对技术概念的理解。部分作者全职参与 DigitalOcean 社区写作团队,而其他作者则通过“ Write for DOnations”项目贡献教程。该项目会将作者的稿酬与捐赠给专注于技术的非营利组织的善款进行等额匹配。所有社区贡献者都秉持着“回馈”读者的精神,通过教学帮助读者,无论这些读者是经验丰富的工程经理,还是初次尝试搭建 Nginx 服务器Jupyter Notebook 的学生。

DigitalOcean 的教程大致可以分为概念型和流程型两类。例如, 《Kubernetes 入门》更偏向概念型,作者会概述某个软件或 DevOps 概念,并将其提炼成易于理解的核心思想。而《如何在 Kubernetes 上设置 Elasticsearch、Fluentd 和 Kibana (EFK) 日志堆栈》则是一个流程型教程,旨在帮助开发人员搭建基础设施。该教程会引导读者逐步完成一项或多项技术的安装和配置,并在此过程中提供许多有价值的见解和背景信息。

成为一名技术作家

成为 DigitalOcean 教程撰稿人并没有“唯一”的途径。Mitchell Anicas曾是社区团队的高级技术撰稿人,现在是计费团队的高级软件工程师,他的职业生涯始于夏威夷大学的系统管理员。搬到纽约后,他利用自己多年在系统管理以及自动化配置和部署方面的经验,开始全职撰写 Linux 和基础设施教程。

“我以前做系统管理员的时候,参考的很多教程要么不完整,要么质量不高。很多都是些博客文章,说‘我就是这么做的’之类的,”他说道。“因为我曾经也是系统管理员,所以我很能理解读者的感受。” 虽然他以前从未写过教程,但在其他社区作者的帮助下(所有教程都由社区团队的其他成员进行同行评审和技术测试),他开始发表文章,例如《如何在Ubuntu 14.04上安装Elasticsearch、Logstash和Kibana(ELK Stack)》《适用于Web应用程序的5种常见服务器配置》 。

另一方面,居住在阿姆斯特丹的软件工程师兼作家艾丽卡·海蒂(Erika Heidi)一直都是一名作家。“我从小就喜欢写作,”她说。“我发现我可以利用博客平台来记录一些技术方面的内容,比如搭建服务器和解决常见的Linux问题,既可以作为我日后的参考,也可以分享我的学习心得。”

作为社区作者,她贡献了许多教程,从操作步骤详尽的《如何在 Ubuntu 16.04 上使用 Let's Encrypt 保护 Apache 服务器》到概念性文章,例如《什么是高可用性》《配置管理入门》,这些文章都源于她作为 DevOps 工程师的丰富经验。与 Mitchell 一样,她的技术经验使她能够敏锐地洞察同行们面临的问题,并提出能够弥补这些不足的解决方案。

杰里米·莫里斯 (Jeremy Morris)发布他的第一篇 DigitalOcean 教程的经历与此类似:“大学期间,我主修计算机科学,偶尔会写一些博客文章,分享我在实习中学到的东西,以此加深对相关主题的理解,并与他人分享我的知识。”他回忆道。他的一位教授,丽莎·塔利亚费里 (Lisa Tagliaferri),如今是 DigitalOcean 内部社区撰稿团队的负责人,建议他利用自己新掌握的 Python 和 Django 经验,撰写一系列关于搭建博客的教程。最终,他发布了一系列 Django 教程,例如《如何在 Ubuntu 16.04 上安装 Django 并搭建开发环境》《如何创建 Django 应用并将其连接到数据库》以及《如何创建 Django 模型》,所有这些主题都是他在工作中积累的。

米切尔、艾丽卡和杰里米在各自科技职业生涯的不同阶段都成为了作家。他们共同的愿望是帮助同行,分享他们苦心钻研的、针对棘手 DevOps 问题的解决方案,这促使他们发布了第一批 DigitalOcean 教程。虽然写作和教育他人需要他们培养独特的沟通技巧,但他们发现,将清晰易懂地描述解决方案的挑战与自身的工程经验相结合,是非常值得的。

为什么要写作?

技术写作可以成为工程工作的有力补充,它要求作者对概念的理解和处理深度远超日常工作所需。作为一名DevOps工程师,Erika为了深入理解她所使用的技术,发现撰写教程能帮助她真正熟悉新概念:“工程中有很多东西我都知道如何做,因为我以前做过很多次,而且它们确实有效,但如果让我解释它的工作原理,我就解释不清楚了,”她说道。“写作帮助我理清思路,因为我必须解释这些想法,并将它们组织成逻辑步骤。”

这也可以是一项非常有意义的事情。通过发布开源技术教程,Erika 觉得她正在帮助那些在她学习过程中给予过她帮助的人:“我相信这种满足感来自于分享一些可能对其他人有用的东西。我经常在网上搜索教程和各种操作方法,而这正是我回馈社区的一种方式。”

米切尔也表达了这种通过教程分享经验和知识的感受:“能够通过写作帮助成千上万的人真是太棒了,尤其是为 DigitalOcean 写教程,他们的教程受到广大开发者社区的尊重和认可。我参加会议时会遇到一些人,他们会说‘哦,我用了你的教程搭建了一个 ELK 技术栈,非常感谢!’”

勇敢尝试,投身技术写作

那么,如何开始撰写你的第一篇 DevOps、软件开发或系统教程呢?当然是直接挑战高难度!通过“Write for DOnations”计划,你可以提交一篇简短的写作样本(可以参考这份建议主题列表获取灵感),并与我们的社区编辑合作,对你的文章进行编辑、技术测试、校对,并指导你最终发表。此外,你不仅会获得稿酬,DigitalOcean 还会将你的稿酬与你选择的科技慈善机构的捐款金额进行等额匹配。迄今为止,DigitalOcean 已通过外部作者投稿和“Write for DOnations”计划捐赠了超过 13,000 美元!

此外,社区团队经常招募新的撰稿人、编辑和开发者布道师,负责制作、整理和发布网络上最优质的软件教程。如果您是 DevOps 或软件工程师,并且拥有文档或其他内容的写作经验,请访问我们的招聘页面,查看最新的全职社区职位空缺列表。

虽然他可能指的并非备份和复制大型分布式 MySQL 数据库的痛苦,但让海明威的话指引你开启技术写作之旅:“用力而清晰地写出那些令人痛苦的事情。”

文章来源:https://dev.to/digitalocean/becoming-a-technical-writer-the-paths-3-engineers-took-to-their-first-community-tutorial-25no