技术写作第二部分:技术写作与文案写作

你可以用很多方法写

在最近的讨论中,提出了技术写作和文案写作的主题。 乍一看,这两个学科似乎很不同,但最终目标却是相同的:使读者满意。

技术作家以有用而简洁的文档满足了客户的需求。

撰稿人为他们的用户提供了写得很好且有趣的文章。

相似之处

如上所述,两个写作学科的主要目标是相同的。 在经历了作者的工作之后,无论期望如何,读者都不会觉得自己在浪费时间。

这两个领域都强调写得好,避免错误以及进行深入研究。 您不想散布错误信息,尤其是在这些不确定的时期。 您也不想别人反驳您的文章或指南存在重大不一致或错误之处。

他们还采用更严格或更宽松的风格指南。 写作的连贯性很重要,以免使读者感到困惑。 而且,无论在哪个领域,都应强制执行拼写,语法和其他规则。

附加材料对于这两个学科都可能非常有用。 一张图像,不管它是怎么写的,都值一千个单词。 图表甚至视频也可以增强文章或指南的功能,因为并非每个读者都能够理解用语言传达的内容。

差异

技术撰稿人的工作从一个更加精确的目标开始:将重要信息传递给用户

另一方面,文案撰稿人从一个更加模糊的目标开始:让一个人阅读他们的作品。

因此,实际写作过程的总体方法是完全不同的。 一种结构清晰,简洁,没有歧义的余地,而另一种则富有想象力且易于解释。 尽管您可以在做一些文案写作时让自己的个性焕发光芒(前提是您可以是主观的),但在技术文档方面,您必须尽可能客观和正式。

在技​​术写作中,您肯定知道用户会因某种原因而来您的工作,因此您希望使您的文档尽可能容易理解。 对于撰稿人而言,其他事情更为重要,例如文章标题或原创内容,这些内容使您的作品在数十亿其他网站中脱颖而出。

一个简单的例子

为了说明写作的这两个方面,让我们考虑一个目标,即传递有关如何使用FreeCodeCamp的信息,FreeCodeCamp是一个专门用于教授其他Web开发的网站。

文案写作

您是否曾经希望可以从事Web开发? 您是否被该领域的众多选择所吸引? 然后再看看FreeCodeCamp吧!

您可以访问官方网站,注册,然后通过课程学习各种奇妙的东西。 从前端到后端,甚至是中端(ba-dum-tss!)。

您还将在整个过程中帮助非营利组织,所以请立即行动!

技术写作

FreeCodeCamp是一个致力于向他人教授Web开发的网站。 通过此链接可以访问它,只需简单注册即可开始学习。

该课程包括:

前端开发认证

数据可视化认证

后端开发认证

全栈开发认证

有关详细信息,请访问官方网站。

无论写作,读者都数不清

您可以是技术撰稿人,文案撰稿人,甚至可以是像技术文案撰稿人这样的十字架,而不是文档,而是提供有关技术,产品和其他类似内容的深入文章。

但是,当您按下键或握笔时,最终目标永远都不应逃避您的注意:读者的满意度。