技术写作路线图
我最近加入了一个由Emy主持的关于技术写作的Twitter群组。
期间,有人提出了一个关于分享技术写作路线图的问题。
我想借此机会更深入地谈谈我对这件事的看法。
首先,我不喜欢路线图。它们缺乏人情味,没有价值,而且可能会让人感到困惑。
如果再深入一层,就会发现问题在于很多人想进入技术写作领域,但他们不知道从哪里开始。
所以,我们应该把这篇文章看作是一篇指导性文章,而不是一份路线图,好吗?
回答“为什么”这个问题
为了帮助你进入技术写作领域,你首先应该回答以下问题:
你为什么想成为一名技术作家?
这个问题的答案将帮助你确定关注重点以及如何进行下一步。
我们来看一些常见的答案:
- 我不知道,但我看到其他人都这么做。
如果你的答案是“否”,那么你应该知道,不成为技术作家也完全没问题!作为一名开发人员,你不需要成为技术作家。
只有当你真正热爱技术写作时,才应该选择这条路。
- 我想提高我的写作水平
或许你想提升自己的技术写作/写作水平。当然,这可能有很多应用场景,但如果是这种情况,你应该专注于扩大受众群体,并积极寻求改进文章的反馈。
- 我想更好地了解技术。
这是我的主要方法。我的日常工作主要使用 React,但我仍然对探索其他技术充满热情。我的博客让我能够研究和撰写关于这些不同技术的文章。
这里的主要重点应该是享受创建项目的乐趣,并找到适合自己的表达方式来解释事物。
- 我想用它赚钱。
是的,你可以通过技术写作赚钱,如果你专注于此,你应该寻找那些付费撰稿的出版物。
你应该专注于撰写引人入胜的内容,并用通俗易懂的方式解释各种主题。
- 我想让大家看到我能解释复杂的话题。
对某些人来说,技术写作能力可以成为他们在线作品集中的宝贵资产。
你可以利用文章来展示你能够以通俗易懂的方式解释复杂的主题。
如果你也想这样做,那就专注于撰写深入且高质量的文章,让读者眼前一亮。
接下来是方法论。
一旦你确定了自己为什么想成为一名技术作家,接下来就必须考虑如何才能成为一名技术作家。
这或许会让你感到惊讶:
你需要写作!
把你学到的一切都写下来,即使只是为了自己留存。你以后或许会想把这些信息写成文章发表。
这是目前为止最简单的技术写作入门方法。用一种能帮助其他人日后解决相同问题的方式来解释你已经解决过的问题。
这种方法的优点在于它对你有效,所以你已经有了一个读者。
作为读者,你可以评估一下,当你需要这篇文章时,它是否真的有用。
记住,技术写作并不一定意味着你必须将文章公开发表。
将其保留在公司内部供自己或公司内部阅读也完全没问题。
撰写文章
让我们来看一些帮助你完成第一篇文章的技巧。
你现在应该已经有了选题思路。如果没有,请按照上述方法寻找选题。
首先写下文章标题,然后确定撰写该文章所需的标题范围。
标题确定后,你就完成了50%。最难的部分已经结束了。去享受你的咖啡/茶或水吧🙏。
带着新的活力回来,开始填写标题之间的段落。
你应该很清楚每个部分需要写什么,即使遇到困难,也要试着重新思考一下你希望在这一部分读到什么内容。
润色文章
文章完成后,可能并不完美。
可能会有拼写错误,也可能不够流畅。
我们先从容易解决的问题开始。
用Grammarly和Hemingway检查一下你的文章。这些都是很棒的应用程序,可以帮助你改进文章中的语法错误。
完成后,请在本地阅读器中打开最终文件并自行阅读。
- 它的流动性好吗?
- 你的观点有道理吗?
- 是否应该添加一些图片来增加吸引力?
如果你对这些问题感到困惑,可以请朋友帮忙校对一下。
(确保他们了解专业术语)
修改一些要点,但不要追求完美。
你也能在文章中找到错误。因此,完美的文章并不存在。
相反,你应该确保自己有90%的把握认为文章足够优秀,然后再发表!
即使有人给你建议,也要接受并采纳。
记住:这不是推文。您可以编辑文章,使其更适合其他读者阅读。
发布地点
不过,你们大多数人可能会成为公众作家,这很好。
所以,一旦你决定要发表文章,接下来就要确定如何以及在哪里发布。
开发者最容易陷入的陷阱是,为了发布一些简单的文本文章而构建过于复杂的工程解决方案。
听起来很疯狂,对吧?但每个人都这么做🤦♂️。
相反,你应该专注于写作。文章的最终目标是为最终用户提供内容。
他们并不关心你的网站看起来如何,而是
更关心你的内容质量如何,以及最重要的是,它是否能解决他们的问题!
所以,与其从零开始搭建博客平台,不如选择一个现成的平台。
一些精选:
其实这并不重要,但根据你的目标,你的受众可能会有所不同,所以要考虑你想接触哪类人群,以及选择的平台是否合适。
选定一个选项后,就大胆地发表那篇文章吧!
别怕它写得不好,让大家都知道你写了你的第一篇文章。
科技界欢迎新作者;大多数人都会乐于阅读你的文章并告诉你他们的想法。
当然,你会收到反馈。你应该欣然接受反馈,并思考对方提出反馈的原因。
- 你是不是没解释清楚?
- 你是不是犯了技术错误?
- 你是不是忘记了什么先决条件?
无论出于什么原因,根据实际情况调整文章,并将这些经验运用到下一篇文章中。
结论
成为一名技术作家并没有一成不变的路线图。
你应该专注于解决文章的主要目的,然后写出你的第一篇文章。
从错误中吸取教训,继续写作,不断重复这个过程。
另外,不要沉迷于创建平台,因为市面上已经有很多优秀的平台了。
最后但同样重要的是:祝你写作愉快!
更多信息请参见《我的写作过程秘诀》
感谢阅读,让我们保持联系!
感谢您阅读我的博客。欢迎订阅我的电子邮件简讯,也可以在Facebook或Twitter上关注我。
文章来源:https://dev.to/dailydevtips1/the-roadmap-to-technical-writing-27nk