斯蒂芬金被退稿_斯蒂芬·金（Stephen King）对技术作家的实用建议

斯蒂芬金被退稿

即使您不喜欢写作并且无意成为一名专业技术作家，您也有机会在职业生涯的某个时候起草报告，邮件列表更新或技术文章。牢记一些实用技巧-以及斯蒂芬•金的可靠写作建议-您可以在开始写作之前改善自己的写作。而且，通过适当的计划，您可以轻松地将内容重新分配给多个受众。

在我们进入写作部分之前，让我们假设您知道自己在写什么以及为什么写作。例如，您可能正在写：

让您的社区了解错误修复或安全更新；
向经理提供项目状态更新；
告知开发人员提交补丁的新流程；
或通知媒体有关最新软件版本的信息。

当您知道自己在写什么以及编写它的目的时，您需要了解您的听众。

你的读者是谁？

在开始写作之前，请退后一步并确保已定义受众。从广义上讲，您可以将读者分为三类：普通，管理和专家。在科罗拉多州立大学的开放式学习环境中，写作工作室 Michel Muraski解释了三类受众：

外行听众没有特殊知识或专业知识。它们与文章的人类兴趣有关。他们通常需要背景信息；他们期望更多的定义和描述；他们可能想要吸引人的图形或视觉效果。

管理听众可能比一般听众了解或可能不了解更多关于该主题的知识，但是他们需要知识，以便他们可以对问题做出决定。做出决策所需的任何背景信息，事实或统计信息都应突出显示。

就知识，演示，图形或视觉效果而言，专家可能是最苛刻的听众。对于“专家”观众，风格和词汇可能是专业的或技术性的，来源引用可靠且最新，文档准确。

如果您是应该接触科技记者的读者，而您没有经验丰富的公关团队带头，请紧抓新闻界 。阅读媒体的保养和进纸。然后再读一遍。如果只有技术记者才是您想要吸引的读者，那么《新闻的照料与养料》将为您服务。否则，请继续阅读。

例如，Opensource.com的读者可以是非专业人员，经理或专家。我们可以假定读者对开放源代码软件，社区或方法感兴趣，但不能假定他们都是有经验的开发人员。例如，如果我们有一篇文章提到微服务，那么我们不应该假设所有读者都知道这意味着什么，因此我们需要提供一个定义或链接到资源。另一方面，我们无需为阅读文章“ 何时需要屏幕截图的任何人”解释文档。，因为我们可以假设只有撰写文档或对文档感兴趣的读者才能阅读。（有关编写项目文档的出色建议，请阅读RTFM？如何编写值得阅读的手册。）

斯蒂芬·金写作

您已经定义了受众群体，但还没有开始写作。取而代之的是，喝杯咖啡或小吃，然后开始阅读。

因为我一直在考虑写小说，所以我在业余时间一直在阅读许多小说。去年夏天，我还读了斯蒂芬·金（Stephen King）的《写作：手Craft.io品回忆录》。尽管他的书是关于写小说的，但他的许多观察也适合技术写作。要成为一名优秀的技术作家，您需要阅读技术内容。

1.好的写作需要阅读

如果您想成为一名作家，您必须做两件事之上：多读多写。我知道这两种方法是不可能的，没有捷径。 〜斯蒂芬·金

当然，你可以当你必须只写的，但期望它是一个斗争，甚至是痛苦的，每一次。是的，很多作家并不擅长阅读，但是他们通常都不是好作家，他们写的东西不一定值得阅读。

如果您收到书面作业，请明确期望。阅读示例会有所帮助。例如，如果您的经理希望更新项目状态，那么阅读示例更新或要包含的信息列表将有助于您达到期望。如果希望您向公司博客提供事件报告，请阅读公司博客或类似网站上的先前报告。在为技术出版物撰写文章之前，请阅读几篇类似的文章，以了解编辑者的需求和读者的期望。

阅读完之后，您对预期的结果有所了解，请花点时间考虑如何重新使用您的内容。如果您打算为多个读者撰写同一主题，请在撰写过程中牢记这一点。例如，在研究我在LinuxCon Europe上发表的演讲时，说出他们的语言：如何为技术和非技术受众编写文章，我意识到，首先写一篇文章会使规划我的演讲更加容易。如果我首先计划好演讲，很可能我以后不会再写更长的文章了（在这种情况下，是一篇文章）。在任何一种情况下，研究都是相同的，但是一种方法（写文章，然后是演讲）比另一种方法（写演讲...永远不会写文章）更有效地利用时间。除了可以参加LinuxCon会议之外，我还可以为Opensource.com读者撰写文章，这帮助我决定了应该首先撰写哪篇文章。

示例：为专业读者（开发人员）写作

Ansible （一种流行的开源自动化工具）的社区副总裁Greg DeKoenigsberg需要让开发人员知道一个新的过程，因此他为开发人员的邮件列表写了一个公告。在他的消息Extras中接受新模块的新过程中，他不需要定义Extras是什么，因为ansible-devel邮件列表的读者应该已经熟悉这个术语。

Greg的邮件列表帖子也适用于Ansible开发人员博客帖子。

示例：为非专业观众（社区）写作

Ansible的社区架构师Robyn Bergeron撰写了有关相同流程的更改，但针对的是更广泛的社区读者。在她的博客文章Ansible Extras Modules + You：您如何提供帮助中，Robyn的受众并未缩小为Ansible开发人员的邮件列表，因此她在第一句话中定义了受众：

这使我们进入了斯蒂芬·金的第二堂课。

2.邀请读者。

您可以稍后回过头来修改您的介绍，但是从一两个引起读者注意并告诉他们期望的句子开始。

开头应邀请读者开始讲故事。它应该说：听着。快过来您想知道这一点。 〜斯蒂芬·金

出色的介绍也可以帮助您（作家）专注于您的受众和目标。

3.讲一个故事。

斯蒂芬·金（Stephen King）对于讲故事有很多建议，这是技术作家正在做的事情。

当您写故事时，您就是在讲故事。重写时，您的主要工作是清除所有与故事无关的内容。 〜斯蒂芬·金

对于该故事而言，所有不必要的东西都可以忽略。您是否正在编写HowTo以便开始使用开源图形程序？考虑链接到项目站点上的安装说明，除非文档中未提供这些说明。

4.删除无聊的部分。

当人们问我他们的文章应该多长时，答案是必要的 。除非您在狭窄的空间（例如一页印刷的杂志）中书写，否则字数统计非常灵活。但是，如果您发现为技术文章写了1000多个单词，或者为项目更新写了500多个单词，请重新阅读文本以查看是否意外包含了无聊的部分。金说，把那些留在外面。

通常，当我想到起搏时，我会回到Elmore Leonard那里，他通过说他只是省去了无聊的部分而完美地解释了这一点。这表明应该加快步伐，而这正是我们大多数人最终要做的（杀死亲爱的人，杀死亲爱的人，即使它伤了以惯性为中心的小涂鸦者的心，杀死亲爱的人。） 〜斯蒂芬·金（Stephen King）

如果您的单词多于1,000个，并且没有枯燥的部分，请考虑将您的文章分成更小，更易消化的部分，例如分为两部分的系列。

例如，Greg在ansible-devel邮件列表中的帖子忽略了有关开发模块的详细信息。相反，他提供了指向模块准则的链接。毕竟，他不是为Ansible模块开发人员写信的，所以他可以省去那些无聊的部分。

在向更广泛的Ansible社区读者发布的示例博客文章中，Robyn提供了一个简短的背景信息：

密切关注各种Ansible存储库的人们可能已经注意到，您友好的社区Ansible社区团队...一直在挖掘大量相当大的问题积压和拉动请求，主要是在Extras和Core模块存储库中。 ...我们已经确定的主要问题之一是过程中的瓶颈...

在陈述问题之后，她解释了解决方案：

因此：一个新的过程诞生了。我鼓励您阅读详细信息，特别是如果您有兴趣帮助审核，或者已经对Ansible做出了贡献，Greg在星期五在ansible-project和ansible-devel邮件列表中概述了这些细节。也就是说，这是重要的亮点...

对于社区用户，Robyn链接到无聊的部分，其中包括Greg为更多技术用户提供的帖子，Ansible文档，模块指南以及如何做出贡献。

概述

除了内容简介外，大纲还可以帮助您始终专注于受众和目标。以下是几个示例概述：

新闻或社区公告：

简介（邀请读者参加）
提供简要背景（陈述问题）
分享新闻（说明解决方案）
结论（包括重要的日期或行动项）

技术文章，教程或白皮书：

简介（邀请读者参加）
提供简要背景（陈述问题）
分享新闻（说明解决方案）
获得技术（操作步骤，常见问题解答）
结论（包括重要的日期或行动项）

根据您所写的内容，您可能希望在结论后包括其他资源，例如文档链接，新闻联系人或社区资源，例如到社交媒体帐户，IRC频道和邮件列表的链接。

媒体的“照料与馈送”建议在新闻稿中包含一份情况介绍，但要包括的事实清单也可以很好地用于项目更新和公告。情况说明书应包括：

什么是产品
首次发布时
它在什么平台上运行
什么是配置要求
要花多少钱
与媒体联系
公众的URL和其他联系信息

产品的名称，首次发布时的产品，运行的平台，配置要求和成本都可以很好地包含在公告或文章的开头。

完成草稿后，休息一下，然后重新看一眼。在进行修订之前，从几个同事那里征求意见是一个好主意。如果您不与任何具有丰富写作经验并且知道您的主题的人一起工作，请与您的网络联系。理想情况下，您需要的是那些会坦率诚实且周到的人的反馈，而不是会动摇您自我的人的反馈。无论如何，请记住，如果您不同意所有建议的修订，则不必接受它们-您的名字会附在您的文字上，因此，请计划对最终草案中的内容负责。

5.编辑是神圣的。

写是人类，编辑是神圣的。 〜斯蒂芬·金

不要个人批评。相反，要开放思维。例如，最近有一位同事告诉我从我的草稿中删去几乎三分之一的文章，因为我的开头是两篇不完整的文章，而不是一篇完整的故事。他是正确的，我的文章更好，因为我接受了他的建议。

现在，您已经决定要写些什么以及为谁写东西。您已完成研究。您已经草绘了轮廓。而且您知道编辑所写内容的最佳方式。下一步是什么？

6.开始写作。

最恐怖的时刻总是在您开始之前。在那之后，情况只会变得更好。 〜斯蒂芬·金