原文: Writing Tips for Software Developers – How to Become a Better Tech Writer

你或许以为软件开发全是围绕写代码进行的,但事实并非如此。这项工作中很大一部分内容是与他人沟通。随着越来越多的工作转向远程办公的形式,书面交流变得越来越重要

“在一个工程师开始工作的最初几年里,他大概会花 30% 的时间在写作上,而中层管理工程师每天花费 50% 至 70% 的时间写作;高级管理人员花在写作上的时间占到了每天的 70% 以上,甚至 95%。” —— Jon Leydens

我在去年离开了我作为软件工程经理和首席技术官的职位,成为了一名全职写作者。在软件行业工作了十年后,我拿着银行里六个月的存款,决定冒险改变我的职业。

很高兴地说,新职业的一切到现在为止都非常顺利,我的公司最近也因我们的技术文书工作而被 TechCrunch 报道

在创办 Draft.dev 之前,我已经在外面写了很多年的博客和教程,所以我对自己的写作能力相当自信。但在公司创立后,我依然学到了很多。我也遇到了许多优秀的导师和同行,他们一路走来给我提供了写作方面的建议。

图片由 Brad Neathery 发布在 Unsplash
图片由 Brad Neathery 发布在 Unsplash

在这篇文章中,我想分享一些我经常与其他软件开发者分享的写作技巧。他们将帮助你克服所有新写作者会面临的阻力,希望能给你带来尽早开始写作的信心。

1. 从你知道的东西开始写起

“没有人生来就是伟大的作家。从你目前所知道的东西开始写起,并与社区分享它们。你会惊讶于你能影响多少人的生活。” —— Eze Sunday(软件开发人员、技术作家)

要想成为一个比现在更好的写作者,你必须比以往更频繁地写作。任何技能都是如此,但对于写作来说,这可能更难,因为你不能只是在一张纸上随意堆砌一些词藻。你必须有写作的 主题

克服这一障碍的最常见的建议是,开始写你已经知道的事情

Strapi 从事开发者关系的 Daniel Phiri 告诉我:“从你刚解决的问题开始,不管你认为它有多微不足道。”

他也指出,即使一个话题已经被广泛地写过了,你的作品也可以与众不同。“写作是关于视角的,我们每个人的视角就像我们个体本身一样独特。”

Eze Sunday 重申了这个观点:“世上的确有很多文章,但是,在你刚开始的时候,你会发现没有多少好文章会以你喜欢的方式来解释事情。”

2. 专注于少数高质量的作品

“质量胜过数量”,James Hickey 如是跟我说。“专注于写高质量的文章,而不是写一堆 一般 的文章……如果你的内容质量只是 一般,没有人会对它留下深刻印象。”

James 是一位资深的 .NET 开发人员、微软 MVP、作家和演讲者,家里有八个小孩,所以对他而言,找出时间写作总是一个挑战。他的解决办法是谨慎选择他要写的内容,一旦他定好主题,他就会深入研究。

这种做事风格在他的作品中可见一斑,比如这篇登上了 Hacker News 头版的关于电子商务数据模型的文章

图表来自 James Hickey 关于电子商务数据模型的文章
图表来自 James Hickey 关于电子商务数据模型的文章

我同样发现,我最受欢迎的一些博文正是那些真正深入到某个主题的文章。

举个例子,我个人博客上最受欢迎的文章之一是这份 4500 字的 API 开发指南。我承认我写了许多比这短的文章,但要把一件事讲透彻,有些话总是要说的。

3. “完美”是“足够好”的敌人

从另一方面来讲,不要让推动你写出最好内容的动力阻止你按下“发布”键。

在 FusionAuth 负责给新开发者的信和开发者关系的 Dan Moore 提出了这个建议:

“‘完美’是‘足够好’的敌人。为了解决这个问题,我喜欢为自己的写作限时,即使当时间限制到了的时候文章还不完美,我也会发布它……或许你的文章不能登上 Hacker News 的头版,但我能保证,如果你不发表,没有人会读它。”

许多新手作家过份地在意文章的细节,而不是他们想法的结构与组织。说实话,如果读者能跟上你的逻辑,他们很有可能并不会在意那些拼写和语法错误。

Alpha Particle 公司的首席技术官 Keanan Koppenhaver 告诉我,过度在意完美的语法,可能会使你的作品看上去太过于机械化而毁掉它:

“我们常常容易陷入试图使你的作品达到最好的状态:完美的语法、伟大的句子结构等等。我曾使用海明威编辑器等工具来使我的写作‘技术上正确’,但当我重新阅读我的作品时,它看起来很陈旧,就像由人工智能创作的一样。”

图片由 Rock'n Roll Monkey 发布在 Unsplash
图片由 Rock'n Roll Monkey 发布在 Unsplash

4. 留出时间定期写作

“你要像对待任何习惯一样对待[写作],并给它留出时间。我发现有件事很有帮助,那就是在早上做的第一件事就是写作,你甚至可以早一点起床。我不是一个习惯早起的人,但我仍然觉得这是我最有精力去写作的时候。在这个时刻,没有其它事情会占用我的精神。” —— Adam DuVander(EveryDeveloper 的创始人)

虽然前面说过,但我要再次重申这一点:要想成为一名更好的作家,你必须更经常地写作。不过,这对每个人来说都是不同的。

就我个人而言,我每周都会在日历上定好写作时间。我发现,当我专注于写作 4-8 个小时时,我会达到最佳的工作效果,而不是在试图把写作塞进一天中零碎的休息时间。

y1V3iiX

当然,并不是所有人都像我这样。Stephanie Morillo 是一位技术交流专家,她就适合在更短的时间段里写作。

“我用时间块(timeboxes)来管理写作:如果我计划写一份讲稿或一篇博文,我会在一天或几天内留出几个 30 分钟的时间段,坐下来写。”

她指出,这些较小的时间块对她的日程安排来说更现实,它使她能够取得进展并增加产出:“无论你在一天内写 10 个字、100 个字还是 1000 个字,你仍然在朝着你的目标取得进展。”

另一种策略是让写作成为一种日常习惯。经营 Developer Avocados 通讯的 Alex Lakatos 在去年的部分时间里完成了一个每日写作挑战:

💡 平均下来,形成一个新的习惯需要 66 天。现在离 2021年还剩 65 天,我们何不早点开始进行我们的新年计划呢?

以我的计划为例:我正在努力持续地发布内容,所以在今年剩下的时间里,我将尝试每天至少写 100 字。 pic.twitter.com/M0dHrJ36ef

— Alex Lakatos 👨‍💻🥑 (@lakatos88) 2020 年 10 月 28 日

关键在于,每个人都是不同的,没有一个足够普适的方法来规划预留给写作的时间。Keanan Koppenhaver 跟我说:“最主要的事情是要找到一个时间,让你的大脑能够集中精力、有创造力,真正把你的想法以连贯的方式记录下来。”

5. 管理你的期望值

“诚然,让别人读你的文章是很好的,但为自己而写作也是非常有价值的,而且你能保证绝对会有人读它。因此,首先也是最重要的事就是为自己写作。” —— Dan Moore

看到自己写的文章如病毒般传播所带来的快感是非常难以自拔的。在过去十年中,我发表了数百篇博客文章,但只有其中五篇登上了 Hacker News 的头版。这并不算什么令人印象深刻的点击率。

这就是为什么你应该主要是为自己而写作。你甚至不需要像 Stephanie Morillo 所说的那样公开发表东西:

“坚持写日记,写下关于工作、你的一天、你的生活、你的情绪的笔记。写日记让你有机会在没有自我意识的情况下写作,因为你在写作时不需要考虑听众;你只是为自己而写。”

最后,当你开始写作时,必须牢记你的目标。你是否只是为了记录自己的学习成果而写作?你是想推广一本书、课程或产品吗?你要通过写作获得报酬,还是只是为了好玩?

Adam DuVander 指出,对自己的这些期望保持诚实是至关重要的。他告诉我:“决定写作是作为副业还是主业,这两种选择都是可以的,但你应该设好你的期望值……在工程职位上有许多地方要用到写作。”

结论

你的前100篇博客、视频、帖子、推特、生活、播客、创作可能都是垃圾

克服心里的障碍,去做吧!先过了这 100 关再说

反正几乎没有人会看到它,就把这当作是练习吧

这就是你为创作而付出的代价

— The BKH 🤳🏾 (@thebkh) 2020 年 12 月 12 日

正如 Brian Kofi Hollingsworth 在上文所说的,只有当你开始做一件事,你才可能变得更好。无论你是想利用写作来使你的事业更进一步、赚取副业收入、还是帮助社会上的其他人,如果你想变得更好,你就必须开始多做。

你对那些希望成为更好的作家的软件开发者有什么好建议?如果你有什么要补充的,我很乐意在推特上听到你的声音