为什么写作对你的开发者职业生涯很重要
介绍
清晰的思维
沟通便利
对社区的涟漪效应
结论
参考
介绍
当你第一次开始学习编程时。
您是否被迫学习编写文档,而只是给您一些东西来“编写 hello world”?
随着我作为一名开发人员不断进步,我并没有意识到学习写作是我们作为一名开发人员需要学习的最重要的技能之一。
因为如果没有它,大量的工作时间就会被浪费。
因为我们缺乏理解,也不清楚如何向人们传达。
当我尝试沟通做某事时,我遇到了同样的问题。
这导致另一个开发人员在实现它时在技术实现上存在巨大差异。
清晰的思维
我记得当时我正在听蒂姆·费里斯 (Tim Ferriss) 的一档节目。
他正在采访 Airbnb 或 Spotify 的一位创始人,为他们的初创公司招募工程师。
创始人回应说,他会关注其他领域,而不仅仅是工程师编写的技术代码。
相反,他们通过纸上的涂鸦来了解他们如何分解和解决问题。
工程师的聘用取决于他们在编写第一行代码之前如何编写解决方案。
沟通便利
写得好、清晰的额外好处是需要反复交流要实施的内容。
当您与客户或用户沟通时。
我一直很喜欢KISS的想法,这样你就可以传达你的意图。
即使某人不具备背景知识或背景来理解整个项目。
因此我建议你努力为外行人写作。
再加上Grammarly等工具的兴起。
通过真人或人工智能的快速反馈来帮助您写得更好,使写作变得更加容易。
对社区的涟漪效应
如果您是 API 开发人员,那么 API 采用的关键之一就是拥有高质量的文档。
直到今天,我仍然很喜欢Twillio、Postman、DigitalOcean、Kong和Stripe等公司。
投资并重视技术文档的高质量写作。
因为如果没有这一点,我相信他们将无法吸引新的开发人员或说服开发团队使用他们的产品或服务。
这样我就可以通过安装和使用该包来完成我想要为我的项目提供的功能。
除了贡献代码之外,您还可以通过文档提供帮助。
使人们能够更轻松地开始使用该软件。
当我重写 Freecodeamp 中的一份 Python 指南的文档时,我也做了类似的事情。
结论
我希望您能够获得更好的见解,并有兴趣学习如何以开发人员的身份写出更好的文章。
相反,它是关于我们试图在正确的背景下解决的人类问题。
如果您喜欢这篇文章,请订阅我的“冒险家通讯” ,每周获取Python、初创企业和Web 开发领域的更新信息。
您也可以关注我,获取我在Dev上文章的最新更新
原帖主题为“为什么写作对你的开发者职业很重要” - 阅读时间:3 分钟,封面图片由 Aaron Burden 在 Unsplash 上拍摄
参考
- 写作的重要性
- 第四稿写作过程
- 论写作
- 为什么开发人员应该知道如何编写
- 编写交付的开发者内容
- 吻
- Grammarly
- 创建易于使用、引人注目的 API 文档的 10 种方法
- 特维利奥
- 邮差
- DigitalOcean
- 香港
- [条纹](https://stripe.com/en-sg
- 如何贡献
- 吉姆·柯林斯——与一位隐居博学者的罕见访谈(#361)