撰写(技术)文章的主观指南

您是否曾经考虑过撰写技术文章与他人共享您的知识,却不知道如何做? 你是在正确的地方。 在本文中,我将尝试指导您完成整个过程,并突出显示您应特别注意的部分。

首先,最重要的是,您应该在开始写作之前就计划好文章 。 一个好的计划将确保您在工作中包括所有想要的东西,帮助您收集想法并将它们排列正确,因此在实际写作过程中,您的思维可以专注于实际内容,查找复杂的单词和完善语法。

通常,一切都从写在纸上的几个词开始……

首先想出一个主意可能很困难,但有时只有两个字就足以使创意源源不断。 就个人而言, 我通常使用 GoogleDocs 创建一本草稿本 ,在其中收集潜在的研究材料,对给定主题的单一想法以及当场撰写的简短段落。 这通常发生在执行日常任务的过程中,有时甚至是在写文章之前数月甚至数月。

您可以做的另一件事,但这也是您可以轻松跳过的步骤,是在电话,日历中或在便签上创建提醒 ,以不断提醒您开始或继续写给定主题。 有时候,很难强迫自己写下前几个单词。

简单的思维导图可以帮助您围绕核心概念组织文章

如果您在概念和较小细节的组织之间进行平滑过渡时遇到困难,那么一个好主意是准备一个思维导图,以查看它们之间如何精确地相互联系。 如果您不想使用笔和纸,可以使用诸如mindmup之类的工具轻松创建许多思维导图。

当一切似乎准备就绪时,您会认为是时候(最终)开始写作了,但是还没那么快。 在将手指放在键盘上之前,请仔细查看在思维导图(和便签本)中收集的所有内容,并确定它是否有价值,足以将其转化为有见地的文章。 如果答案是肯定的,那么很好,您就可以开始写作了!

创建文章时,我要做的第一件事是根据自己在思维导图中想出的内容写下 GoogleDocs中的标题 。 请记住,优秀的文章应该引起读者的注意,并表达给定段落的意义-没有人说这会很容易! 此外,这些内容并不是一成不变的-随着内容的增长,可以随时对其进行修改。

现在,当您调整标题时,可以用实际内容填充它们之间的空间 。 技术文章是一种特殊的写作形式,通常包含代码片段或动画截图。 如果您可以尝试插入其中的一些技巧,它将引起读者的更多关注,并且一定会帮助他们实现您的技巧/查看其工作原理。 不过,不要过度使用-动画模因很有趣,但这只是文章,而不是游乐园。 到处都有太多的动画可以使读者从实际内容中分散注意力。

发布前进行共享,验证和讨论您的工作不仅可以限制错误数量,还可以为文章引入全新的想法

当您准备好文章时,请不要立即发布。 很有可能出现问题,应从技术角度进行纠正。 我总是请开发者朋友检查我的工作并相应地应用他们的评论。 经过技术校对后 ,我将我的文章发送给另一种语言版本,以确保更正不会干扰其含义。

我使用Medium发布文章,因此下一步是在此处创建文章草稿 。 如果格式可以接受,我将继续寻找适合我的文章主题并对其进行补充的图像。 在这里,放在标题中的图像是最重要的。 确保它(甚至是松散地)链接到该主题,这将使您的工作更容易辨认并且更容易记住。 具有讽刺意味的是,很多时候,如果您想正确地做,这是最难的部分。

当一切准备就绪时,现在该再次对您的优秀著作进行校对 。 总有一些东西会引起您的注意,并将其留给敏锐的读者来发现较小的拼写错误。 安全要比后悔好!

最后,是时候了,您准备好将杰作发布到网络空间 。 就像我说的那样,我将自己的文章发布在Medium上,但是我也将其提交到公司的博客上发布,因此请询问您的公司是否也有兴趣发布您的文章。

确保有尽可能多的人有机会看到您的作品

最后, 请记住与他人分享有关您的文章的好消息 。 我在Twitter,Linkedin,Facebook,Reddit等社交媒体发布了我的文章。 您会惊讶于这样的简单动作能获得多少认可。 您也可以请同事在他们的平台上共享它,就像您为自己提供免费广告一样。

如果您认为仅此而已,那么您可能就错了。 就个人而言,我想给我的文章做一个发布后的阅读,以纠正最后的错别字和错误 。 一两天后焕然一新可以为您的工作带来奇迹。

我保证,仅此而已,您已经有了一条大写的“ A”文章。 现在剩下要做的就是耐心等待您对书面作品的喜欢和评论。 您可能会得到一些反馈,因此请始终注意任何建设性的批评,以改善您的写作并使您的出版物越来越好。 此外,请始终以尊重的态度回应评论,并尝试了解您的听众-这才是最重要的。

最重要的是,请记住,没有人在第一次尝试中就能正确完成所有事情。 不要让批评阻止您,只是继续写作并从中学习。 希望能尽快收到您的来信。 祝好运!