软件开发人员的写作指南

开发人员技术写作终极指南

我开始写作是因为我想分享我的科技经验，也想改变我的生活。我喜欢各种想法，但却没有人可以谈论。所以，每当我提出一些好话题时，我那些朝九晚五的同事都会嘲笑我。

> 三年后，我可以说，在互联网上写作是我做出的最好的职业决定之一。

本文包含过去 3 年中改进和提高我写作效率的见解。

什么是技术写作？

技术写作是指以简洁、清晰的方式撰写复杂主题的能力。

在技​​术领域，作为一名软件开发人员，磨练您的写作技能可能是开启新机遇和推动您的职业生涯迈向新高度的关键。

• 无论是给您的同事撰写一封引人注目的电子邮件。
• 为下一个重大项目起草提案。
• 清晰简洁地表达你的想法。
• 为您的第一次会议发送 CFP。
• 为您的经理起草年终评估。
• 发送一封冷电子邮件或直接消息来寻找机会。

有效的写作可以打开大门并帮助您在组织内产生更大的影响。

因此，如果您想将自己的职业生涯提升到一个新的水平，请不要忘记掌握书面文字的重要性。

写作给了你翅膀。它为你的职业生涯开启了互联网的潜力。

公开写作就是将您的想法广播到互联网上，从而吸引人们和机会。

科技写作中的叙事艺术

• 您的博客应该以这样的方式编写，即您的读者可以使用其内容，并且在阅读之后感觉好像学到了新的东西。
• 您应该将这种复杂性分解为可以指导读者的逻辑步骤和主题。
• 我们在学校里学到，每个故事都应该有开头、中间和结尾。博客也一样。
• 人们从真实的故事中学到的东西比从别人讲述中学到的更多。

生活就是讲故事，我们每个人都有一个故事，并且我们都喜欢它。

技术写作是轻松赚钱的神话

在我职业生涯的早期（技术写作之前），我意识到大多数人并不擅长以书面形式表达自己的想法。

好钱？绝对好。轻松赚钱？根本不可能。

在技​​术领域，许多初学者错误地认为写作的目标受众是一个单一的群体，而事实上，由于这个原因，写作的目标受众是非常多样化的，糟糕的写作比好的写作多。

撰写或编辑博客文章需要考虑许多因素，包括语法、风格手册、可访问性、准确性和一致性。这是一个需要权衡的过程。

Grammarly 完美是一回事，但传达清晰信息的能力（尤其是有关新产品的信息、与 X 和 Y 建立集成或分享您在新的副项目中构建的内容）需要多年的练习。

要想有效地撰写某个主题的文章，需要进行广泛的研究。强大的研究技巧能够加深你的理解，并与那些理解有限的人进行沟通。

技术写作反馈请求

我在 Twitter 私信中也用了这个策略。我把草稿发给了 IT 领域的资深作家或开发者。

看看今年我作为开发者倡导者的经历的截图。

写作对开发人员的重要性

随着远程工作变得越来越流行，软件工程中的许多职位都需要强大的写作技能。

• 长篇写作将帮助您成为更好的思考者和开发者。
• 长篇写作可以帮助你建立个人品牌。

例如：假设一位开发者正在为一家热门咖啡连锁店开发一款新的移动应用。这款应用允许顾客直接通过手机点餐和付款。开发者花费了无数时间编写和调试应用，以确保其运行顺畅。然而，应用发布后，很快就暴露出一些严重的可用性问题，导致用户感到不满。

开发人员知道他们需要尽快修复这些问题。然而，他们也意识到，在没有清晰理解问题的情况下，不能盲目地做出修改。因此，他们会退一步，撰写一份详细的报告，概述他们观察到的问题，并提出相应的解决方案。

该报告写得通俗易懂，并包含屏幕截图和其他视觉辅助工具，以帮助说明问题和提出的解决方案。

在这种情况下，开发人员的写作技巧在清晰有效地传达应用程序的问题和提出解决方案方面发挥了至关重要的作用。

如果没有很强的写作技巧，可能需要更长的时间来发现和解决问题。

长期撰写有价值的博客是一个绝佳的策略，它不仅能吸引读者，还能吸引潜在客户和商业伙伴偶然发现你的作品。

公开写作可能会产生多种二阶效应

• 对您的专业或个人品牌的影响
• 交流机会
• 提高可见度
• 建立你的声誉
• 与更广泛的受众互动

为科技内容创建引人入胜的标题

假设你曾经尝试通过一系列博客文章或文章来推广一款技术产品。在这种情况下，你就会知道这是什么样的。

• 做出承诺并具体化。
• 使用流行文化参考：例如，“像老板一样加载：提高网站速度的技巧”
• 使用强有力的动词：像“发现”、“解锁”和“转变”这样的动词可以为标题和副标题增添趣味和行动感。例如，“发现优化网站加载速度的秘诀”
• 使用数字和列表：编号列表和项目符号更易于扫描，因此请考虑在标题和副标题中使用它们。

> 例如，“提高网站加载速度的 5 大技巧”

• 使用表情符号：表情符号可以为标题和副标题增添趣味和视觉元素，有助于提升内容的吸引力和记忆力。但请务必谨慎使用，并适度使用，以免读者感到信息量过大，造成阅读负担。

> 例如，“⏱️ 是时候加快速度了：优化网站加载时间的技巧”

更多示例

• “技术故障排除 101：修复常见计算机问题的初学者指南”
• 《HTML AZ：Web 开发基础综合指南》
• “掌握命令行：使用 Linux 和 Unix 的技巧和窍门”

记住，专业人士不会只创作一个标题。他们会创作很多标题。

克服写作障碍的策略

• 将任务分解成更小的部分：不要一次性处理整个博客文章，而是将其分成更小、更易于管理的段落。

例如：我正在写一本书《博客开发者：将你对代码和写作的热情转化为可观副业收入的指南》

• 留出专门的写作时间：每天或每周安排一段特定的时间来写作。养成规律的写作习惯可以帮助你保持专注，取得进步。

• 创建一个支持性写作环境：找到一个安静、无干扰的工作场所，并考虑使用番茄工作法来帮助您保持专注。
• 需要时寻求帮助：如果你感到困惑或不知所措，不要害怕寻求帮助。同事或导师可以提供宝贵的反馈。
• 太多开发者和作家认为营销超出了他们的能力范围。但销售是生活中必不可少的一部分。

> 无论你的写作水平有多好，吸引良好的读者群都需要时间。

• 关注可以买到，但信任买不到。信任需要努力争取，而这正是写作让信任如此珍贵的原因。

软件开发人员的写作技巧

1. 明确你的读者：开始写作之前，你必须清楚自己是为谁而写。这有助于你根据读者的需求和理解水平调整写作风格。

2. 使用简单明了的语言：避免使用听众可能听不懂的术语或复杂语言。相反，要使用简单明了、易于阅读和理解的语言。

3. 组织信息：确保以合乎逻辑且易于理解的方式组织信息。使用标题、副标题和列表来划分文本，使其更易于阅读。

4. 举例说明：举例是阐明概念并使其更易于理解的绝佳方式。尽量在合适的地方添加例子，以帮助受众理解你正在呈现的信息。

5. 简洁明了：技术写作应简洁明了。避免包含不必要的信息或重复内容。

6. 使用视觉效果：图表、图表和图像等视觉效果可以有效补充您的文本，使其更易于理解。在适当的地方使用视觉效果来增强您的文档。

7. 审阅和修改：在发布之前，务必审阅和修改你的文章。这将有助于你发现错误，澄清任何令人困惑的信息，并提高文档的整体质量。

我强烈建议您阅读 Gergely 的博客文章“成为更好的软件工程师作家” 。

写作如何增加机会

• 技术写作可以帮助开发人员向潜在雇主或客户展示他们的专业知识和技能。
• 通过撰写技术文章、博客文章或教程，开发人员可以展示他们在其领域的知识和经验。

• 技术写作帮助开发人员建立个人品牌。
• 技术写作提高了他们的社交、合作和职业发展的机会。
• 技术写作可以帮助开发人员提高沟通和协作技能。

寻找写作机会的最佳方法

• 与私信中的人建立联系
• 展示你的专业知识
• 展示你的作品
• 提供最佳技术内容
• 询问您最喜欢的 DevRel Advocate 是否需要优秀的作家，您可以帮助构建下一个集成、文档或待处理的博客文章。

考虑以下现实世界的例子

全职技术作家/开发者倡导者/开发者关系在亚洲的平均工资为 30-90,000 美元，在美国/欧洲、中东和非洲地区则为该数字的 2-4 倍。

大多数这类企业都不愿意花费数周时间撰写内容。即使他们设法找到一个优秀的内容撰写者，每周从他们那里获得一篇好内容，每个技术博客也要花费 1000 到 5000 美元。

并且在内部维持类似的数量/速度/质量是困难的，因为最好的技术员工很快就会因生成内容而精疲力竭和/或被拉入其他项目，因为没有营销团队有足够的技术人员。

在这里，您可以填补他们积压的空白，从外部成为一名优秀的参与者，这对于企业和您作为创造者来说都是双赢的。

结论

丹尼尔开始写作的想法非常棒。

> 成功的关键在于开始写作。无需任何技巧或捷径——直接开始创作即可。

问自己以下问题可以帮助你集中精力写更多东西。

• 我比其他科技作家做得更好吗？
• 长期写博客能做什么？
• 我想把我的博客技能带到哪里？

玩游戏不是为了输，而是为了赢。

作为一名技术作家，您可以同时学习、提供帮助和赚钱。

当你踏上写作​​之旅时，重要的是要记住跳出固有思维模式并尝试新事物。

不要害怕冒险和挑战自己。无论是尝试新的写作风格、探索新的主题，还是寻找吸引读者的独特方式，关键在于保持开放的心态，并愿意尝试新事物。

如果您愿意走出自己的舒适区并抓住机会，谁知道您会遇到什么样的惊人机会和经历？

所以，别害怕冒险，看看它会带给你什么。祝你写作愉快！

如果您喜欢这篇文章，您也会喜欢我的时事通讯：

点击这里加入：2-1-1 职业发展简报

这篇博文摘自我最近的一本书；如果你喜欢它，你也会喜欢这本书。已有超过140人预订。

您今天就可以预订您的副本。