首先，技术写作的类型是什么。 分类有很多，但最有用的分类取决于您撰写的受众：
- 以传统或专业为导向的写作 ，例如医学研究，技术说明。
为专业人士写作意味着您还必须具有适当的技术背景。 例如，传统的技术作家也可能是程序员，药剂师，工程师。 作者的职称可能是严格的要求。 - 最终用户技术文档 ，例如电子产品，消费产品，用户帮助指南，产品手册。
您所写的读者不是专业人士，这就是为什么尝试尽可能清楚地解释事情的原因。 记住所谓的知识诅咒，即当一个人与他人交流时，在不知不觉中假设他们具有相同的理解背景时，就会发生认知偏差。 事实是您的读者不知道。 而且不必如此。 避免使用特定的术语和行话，如果由于某些原因您不能删除它，请解释其含义。
尽管有受众群体，但仍存在一些常见的技术写作技巧 。
提示1
首先，制定计划： 确定关键材料 ，相关细节和您必须提及的基本要点，标记假定的章节并考虑文档的布局。 现在，当您确定知道文档各部分要讲的内容时，就开始编写。 它与工程图有很多共同点：标记主要元素的位置，然后添加越来越多的细节。
一般而言，技术写作与灵感无关，而是与描述特定项目有关。 因此，如果您感到迷茫而又不知道该写些什么，那就回去计划并改进它。
提示2
Kurt Vonnegut的建议是：“ 只取悦一个人 。 如果您打开一扇窗户，向世界做爱，可以这么说，您的故事将患上肺炎。” 这对技术作家意味着什么：确定谁将阅读您的文档，并为确切的人员类型指定您的作品。 使用角色方法会有所帮助：想象一个虚构的角色，它代表您所写内容的最典型用户。 包括诸如教育，职业，痛苦，目标，兴趣之类的功能，以及任何对识别用户重要的功能。 这有助于了解您的读者并准备更有针对性的文档。
例如， Mark是25岁至35岁的大学毕业生，曾在一家小公司担任项目经理，他的主要职责是协调5-15位IT领域的人员，通常需要时间，他担心会失去流程。
提示3
想象您正在写作的人非常疲惫，疲惫，现在已经是凌晨3点。 尝试写得尽可能简单，使其易于理解 。 包括步骤，然后在每个步骤中添加如何查找该步骤的信息。 避免使用可以用多种方式解释的短语，并避免使用术语。
检查一下自己：完成文档的一部分后，检查一下它是否足够简单，以至于半睡半醒的人都能理解？ 如果答案是“是”，那么您的工作做得很好！
提示4
您的读者正在寻找一种快速的解决方案。 因此，如果可以用5个词清楚地描述主题，则不要多用。 相同的指令可以用500个单词或5000个单词传达，完全不影响整体质量。 无论字数多少，最好的文档对读者都是有效的。
与以前的建议没有冲突，只需足够详细，并避免添加可以跳过而无害的信息。 这里最主要的是要找到平衡。 因此，如果该文档的特定部分相关，那么就顺其自然，否则，不要让任何人阅读。
提示5
前面的要点是关于文档本质的，现在让我们来讨论其形式。 更加直观，在可能的地方使用图像和屏幕截图，在屏幕截图中添加箭头，圆圈，数字，使其更加易于理解。 这一点还为您提供了更简短的机会，并在更少的空间中保留了更多有用的信息。 尝试使用示例而不是仅仅进行解释，这会很有帮助。
提示6
尝试为文档添加更多结构 。 将您的文本分成块，使用段落和章节之间的间隔差异，突出显示某些短语，标记标题，使某些单词变为粗体或斜体，所有这些都使文本易于阅读。
使用您的公司设计来使文件易于识别，并使其提升公司品牌。
提示7
大声朗读是最明显，最容易被忽略的建议。 等待！ 您还将跳过它，但不要跳过。 有时，您想说的话已经根深蒂固，以至于您仍然会错过一些较小的错误。
而不是结论
开始总是不容易的。 如果您正在阅读，那意味着您应该提高自己的技能。 此处列出的提示很有帮助，但最出色的老师是一种体验。 写得越多，你就会变得越好。 尝试分析遇到的文件中您喜欢或不喜欢的内容，这也有助于提高您的专业水平。
然后您将成功。
最初在这里发布。
