软件开发人员写作指南
#javascript #网络开发人员 #初学者 #写作

开发人员技术写作的最终指南

我之所以开始写作，是因为我想分享与技术的经验，需要改变自己的生活。我喜欢想法，但没有人可以谈论它们。因此，当我提出好主题时，我典型的9-5个同事嘲笑我。

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

本文包括过去3年的见解，这些见解提高并提高了我写作的生产率。

什么是技术写作？

技术写作是能够简洁明了的复杂主题的能力。

作为软件开发人员，在技术中，磨练您的写作技巧可能是释放新机会并推动您的职业发展到新高度的关键。

  • 它是否正在向同事撰写引人注目的电子邮件。
  • 起草下一个主要项目的建议。
  • 清楚，清晰地表达您的想法。
  • 为您的第一次会议发送CFP。
  • 为您的经理起草年末审查。
  • 发送冷电子邮件或DM以获取机会。

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

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

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

在公共场合写作正在向互联网广播您的想法，以吸引人们和机会。

技术写作的故事艺术

  • 您的博客应该以您的读者可以使用内容并感觉到他们在阅读后学到新知识的方式写作。
  • 您应该采取这种复杂性并将其分解为逻辑步骤和主题，以指导读者。
  • 每个故事，我们在学校都教导，应该有一个开始，中间和结局。博客也是如此。
  • 人们从真实的故事中学到的比被告知更多。

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

技术写作很容易钱的神话

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

好钱？绝对地。快钱？没有机会。

在科技中，许多初学者错误地认为，目标受众是一个单一的群体，而实际上由于这一井这么多样化，它的写作比出色的好。

编写或编辑博客文章需要您考虑许多因素，包括语法，样式手册，可访问性，准确性和一致性。这是一个平衡的行为。

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

要有效地写一个主题，需要进行广泛的研究。需要强大的研究技能来发展您的理解并与有限理解的人进行沟通。

技术写作的反馈请求

我在Twitter直接消息中使用了此策略。我将草稿发送给了既定的作家或开发人员的倡导者。

查看今年我写有关开发人员倡导者的旅程时的屏幕截图。

Image description

Image description

为开发人员写作的重要性

随着远程工作变得越来越流行，强大的写作技巧对于软件工程中的许多角色都是必需的。

  • 长期写作将帮助您成为更好的思想家和开发人员。
  • 长期写作可以帮助您建立个人品牌。

例如：想象一个开发人员，为一个新的移动应用程序工作，用于流行的咖啡链。该应用程序允许客户直接从手机订购和付款。开发人员花费了无数的时间进行编码和调试应用程序，以确保其运行顺利。但是，当发布该应用程序时，很快就会清楚一些主要的可用性问题引起了客户挫败感。

开发人员知道他们需要尽快解决这些问题。尽管如此，他们还是意识到，如果没有明确了解问题，他们就无法盲目进行改变。因此，他们退后一步，写了一份详细的报告，概述了他们观察到的问题，以及有关如何修复它们的建议解决方案。

该报告是编写且易于理解的，它包括屏幕截图和其他视觉辅助工具，以帮助说明问题和建议的解决方案。

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

没有强大的写作技巧，识别和解决问题可能需要更长的时间。

进行长期价值博客是一个很棒的策略，不仅仅是吸引读者。您还会发现潜在的客户和业务合作伙伴在您的工作中绊倒。

公共写作可以有几种二阶效果

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

为技术内容创建引人入胜的头条新闻

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

  • 做出承诺并具体。
  • 使用流行文化参考：例如，“像老板一样加载：改善网站速度的提示”
  • 使用强动词：诸如“发现”，“解锁”和“变换”之类的动词可以为您的头条和副标题增加兴奋和动作感。例如，“发现优化网站的加载速度的秘诀”
  • 使用数字和列表：编号列表和项目符号，易于扫描，因此请考虑在标题和子标题中使用它们。

>例如，“改善网站的加载速度的前5个技巧”

  • 使用表情符号：表情符号可以为您的头条和副标题添加一个有趣的视觉元素，并有助于使您的内容更加引人注目和令人难忘。只要确保谨慎而适当地使用它们，以免使您的读者过多分心。

>例如，“

更多示例

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

记住，专业人士并没有创建一个标题。他们创建了许多头条。

克服作家的策略

  • 将任务分为较小的块：而不是立即解决整个博客文章，而是将其分为较小，更易于管理的段落。

例如：我如何写一本书“ The Blogging Developer: A Guide to Turning Your Passion for Code and Writing into a Profitable Side Income”

Image description

  • 搁置专门的写作时间：每天或一周都会限制特定时间进行写作。拥有一致的写作常规可以帮助您保持专注并取得进步。
  • 创建一个支持性写作环境：找到一个安静，无干扰的工作场所，并考虑使用Pomodoro技术来帮助您保持专注。
  • 在需要时寻求帮助：如果您感到困惑或不知所措，请不要害怕寻求帮助。同事或导师可以提供有价值的反馈。
  • 太多的开发商和作家认为营销已经超出了联盟。但是销售是生活中必不可少的一部分。

>无论您的写作多么好，建立好受众都会花费时间。

  • 您可以购买注意力，但是您可以购买信任。它必须赚钱，这就是写作如此宝贵的。

软件开发人员的写作技巧

  1. 识别您的受众：在开始写作之前，您必须知道自己正在写的人。这将帮助您根据受众的需求和理解水平来定制写作。

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

  3. 组织您的信息：确保以逻辑且易于遵循的方式组织您的信息。使用标题，子标题和列表来分解您的文本并更容易阅读。

  4. 包括示例：示例可能是说明概念并使其更容易理解的好方法。尝试在适当的地方包含示例，以帮助您的听众了解您提供的信息。

  5. 要简短：技术写作应该简洁明了。避免包括不必要的信息或重复自己。

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

  7. 审查和修订：在发布之前始终审查和修改您的写作。这将帮助您捕获错误，澄清任何令人困惑的信息并提高文档的整体质量。

我强烈建议您阅读Gergely的博客文章“ Becoming a Better Writer as a Software Engineer.”

写作如何增加机会

  • 技术写作可以帮助开发人员向潜在的雇主或客户展示他们的专业知识和技能。
  • 通过撰写技术文章，博客文章或教程，开发人员可以在其领域展示他们的知识和经验。
  • 技术写作帮助开发人员建立个人品牌。
  • 技术写作改善了他们的网络，协作和职业发展的机会。
  • 技术写作可以帮助开发人员提高他们的沟通和协作技巧。

找到写作机会的最佳方法

  • 与DMS中的人建立联系
  • 展示您的专业知识
  • 展示您的工作
  • 提供最好的技术内容
  • 询问您最喜欢的Devrel倡导者，如果他们需要好的作家，您可以帮助您建立下一个集成，文档或该待处理的博客文章。

考虑以下现实世界的示例

全日制技术作家/开发人员倡导者/开发人员关系平均在亚洲获得30-90k的$ 30-90k和2-4x，在美国/EMEA。

这些业务中的大多数不想花几周的时间编写内容。即使他们设法找到一个好人并每周从他们那里获得一件好的内容，每个技术博客$ 1k- $ 5k

并在内部保持相似的数量/速度/质量是很困难的，因为最好的技术员工很快就会因生成内容和/或被吸引到其他项目而被烧毁，因为没有营销团队有足够的技术人员。

这是您可以填补他们的积压的空白，并成为外部的好球员，这对企业和创造者都是双赢。

结论

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

>成功的关键是简单地开始写作。不需要技巧或快捷方式 - 只需开始创建。

问自己以下问题，以帮助您专注于写更多。

  • 我比技术中的其他作家更好？
  • 我长时间在博客上做什么？
  • 我要在哪里掌握我的博客技能？

玩不输。相反。

您可以作为技术作家学习，帮助和赚钱。

当您踏上写作旅程时，重要的是要记住在框外思考并尝试新事物。

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

谁知道如果您愿意走出舒适区并抓住机会，您可能会出现什么惊人的机会和经历？

因此，不要害怕抓住机会，看看它带领您的位置。愉快的写作！

如果您喜欢这篇文章，您会喜欢我的新闻通讯：

Join here: 2-1-1 Career Growth Newsletter