开源软件 商业软件

开源社区入门的一种方法是撰写关于它的文章。 您可以提供技术文档，共享软件使用方式或为Opensource.com撰写文章。 但是，开始写作说起来容易做起来难。 我听到的不写的两个最常见的借口是：“我没什么好说的”和“我不是好作家”。 我在这里消除这两个神话。

你应该写些什么？

“寻找经常被遗忘的故事。”

埃里克·拉森（Erik Larson）

对于某些人来说，写作的最大障碍是产生一个想法或要写作的话题。 陷入思维陷阱是很常见的，“已经写了这个主题，所以为什么要打扰。”

我不是第一个撰写有关写作的文章的人，也不会是最后一个。 我带给我的是我独特的见解以及多年来我学到的东西。 我有很多人问我关于入门或如何提高写作技巧的提示。 我决定将这些建议变成一篇文章。

你的作品是对你的反映。 没有人会讲故事的方式。 您的经验和观点可能正是其他人所需要的。

以下提示可帮助您提出一个主题：

• 您最近学到了什么？ 写下您的学习方式，学到的知识或使您感到惊讶的内容。
• 您经常问什么问题？ 写下答案。
• 您最近是否在搜索how-to文章，并且对任何热门搜索结果都不满意？ 写您想要的文章。
• 您参加过会议或研讨会吗？ 写一个事后总结您学到的东西。
• 您是否开始使用新工具？ 撰写入门指南。

您在写什么类型的文章？

有不同类型的写作，包括：

• 技术文档
• 入门指南
• 博客
• 白皮书或电子书
• 回顾性

内容的类型将影响您的写作风格和语气。 博客更加非正式和对话。 技术文档更加正式和具有指导意义。

你是为谁写的？

每篇著作都应该有一个单一的受众。 受众是您正在写作的人的类型。 在开始写作之前，它有助于记下读者的一些特征。 重要的是要考虑您为谁写的书，以及您不是为谁写的书—确定目标受众将决定包括哪些内容和不包括哪些内容。

例如，这是我在撰写本文时所设想的：

• 具有写作和语法方面的基本知识
• 有兴趣提高写作技巧
• 担任开发人员，销售工程师，客户成功经理或类似角色的技术工作
• 不是经验丰富或高级的作家，在个人或工作博客上可能有几篇已发表的文章，并且想写更多
• 正在写非小说

如果您有面向多个受众的内容，请考虑将其分解为不同受众的不同片段。 听众需要考虑的一些方面：

• 专业水平：新手，中级，高级
• 角色：经理，个人贡献者
• 目标：他们为什么读书？

话语很重要

您选择的字词会对读者产生影响。 难以理解的单词会使文章难以理解。 陌生的单词会使读者感到愚蠢。 某些单词可能会不小心冒犯读者。 作为作家的目标是避免所有这些。 这是如何做。

使用日常语言

使用诸如类的工具来检查您作品的可读性（它不是开源的，但效果非常好）。 例如，在初稿之后，本文被评估为五年级的阅读水平。 海明威还提供有关如何改善写作的建议-识别难以阅读的句子或改变单词选择的地方。

如果您想使用替代词，请查看的建议或的众包建议。

知道要避免的单词

“每当您倾向于写'非常'时，都用'该死'代替；您的编辑器将删除它，并且书写将保持应有的状态。”

马克·吐温

在编写教程或操作指南时，应避免使用一些单词，包括“简单”，“简单”和“公正”。 您，您正在撰写的主题的专家，经过多年的实践可能会发现事情很容易。 初学者可能不会觉得事情简单或容易。 您的读者可能会因为找不到简单的过程或说明而感到沮丧。

您是否曾经因为无法弄清楚作者在说什么而不得不多次重读句子或段落？ 您是否因为对您没有意义而放弃了一篇文章？ 我有。

作为作家，您是否希望读者感到困惑或不明智？ 我希望不是。

在写作中要避免的其他词语：

• 那
• 真
• 非常
• 所以
• 为了

通常，可以在不更改句子含义的情况下删除这些单词。

完成写作后，我在文档中搜索这些单词的实例。 当我搜索此文档时，发现以下句子：

“这并不意味着您的听众只能接受八年级的教育，这意味着您的写作将更容易理解。”

这句话出现了两个“ that”的实例。 他们并没有增加句子的价值。 可以删除它们而不更改其含义。 删除这些实例将缩短句子，并且较短的句子更易于理解。 说到较短的句子，我也将其重写为两个句子。

“这并不意味着您的听众只有八年级的教育。这意味着您的写作将更容易理解。”

使用包容性语言

单词和短语的历史背景可能导致人们感到被排斥或冒犯。 写作时，您想让读者觉得自己被包容了。 当您使用包容性语言时，它会使您的读者感到被理解，尊重和喜欢。 我指的是 Buffer中 。

修改和编辑

“几乎所有好的写作都是从糟糕的第一步开始的。您需要从某个地方开始。”

—安妮·拉莫特（Anne Lamott）

写作是一个反复的过程。 如果您认为作家坐在办公桌前，并且在一小时内准备好一篇完整的文章准备发表，请再考虑一下。 有些文章需要我数周才能完成。 这是我的标准流程：

• 写一份粗略的初稿。 粗糙，我的意思是粗糙 。 我写的时候不用担心语法。 这个想法是让我的脑海里浮现出文字。 此步骤可能需要一个小时到几周的时间。
• 将草稿放一段时间。 根据发布时间的不同，时间可能从几个小时到几天不等。
• 查看草稿。 进行调整和编辑。
• 向同事或朋友寻求反馈。 在反馈的这一阶段，我专注于清晰度。 一切都有意义吗？ 有什么令人困惑的地方吗？
• 纳入反馈。 无论您有多丰富的写作经验，其他作家对您的作品进行评论都会使它变得更好。

在这个阶段，我有一个很扎实的草案。 现在是我最不喜欢写作的部分-编辑。 我前面提到的海明威应用程序不仅可以告诉您阅读水平，还可以提供改善写作的建议。 我还使用语法来帮助进行语法编辑。 有关Grammarly的开源替代方案，请查看或有关 。

我的写作挑战之一是适当地使用逗号。 语法帮助我弄清楚我在哪里错过或滥用了逗号。 语法上确定了与本文最终草案的正确性有关的43个问题。 大多数是逗号错误。

除了语法错误外，该应用程序还提供了一些建议，以帮助您提高清晰度，参与度和交付效果（其中一些功能可能在免费版本中不可用）。 这包括选择单词以及使用主动语音还是被动语音。 我接受一些建议； 其他我拒绝。 在查看了所有警报和建议之后，语法检查会向各个维度进行报告。

不要害怕在写作上寻求帮助。 每个优秀作家的背后都有一个优秀的编辑器或优秀的编辑应用程序。

风格指南

风格指南提供了改善书面交流的标准。 它们包括标点符号，语法和单词用法等方面。 如果为您的公司编写文档，请检查其是否使用样式指南。 如果没有样式指南，或者您正在为自己写书，请遵循以下一些常见样式指南：

写作是与社区分享您的思想和知识的一种方式。 开始写作的唯一方法是开始打字。 使用这些建议来微调您的写作。

翻译自:

开源软件 商业软件