当今人们所了解的许多所需技术信息通常是通过计算机软件、各种工具和电子设备来加载的。技术沟通对于共享信息并帮助用户更好地了解技术或产品至关重要。需要时间来想出 技术信息 以及翻译内容的额外时间。
制造商分享知识的方式是通过 技术文档。
技术文档的定义
如前所述，制造商创建技术文档来帮助最终用户了解他们使用的小工具或产品的架构和工作动态。它是一个 产品的详细描述 的网络 指南 关于如何使用该项目。
技术文件的部分内容
技术文档的组成部分会有所不同，具体取决于文档本身及其目的。广义上讲，一个 操作方法文档 由三个基本部分组成：
- 目录
- 实际说明
- 索引或术语表
技术文件的要素
每个主组件中还有很多子组件，需要专家编写技术文档。
1. 前盖
- 标题
- 文档编号
- 文档版本
- 产品名称
- 产品版本
- 文档发布日期
- 版权声明、日期、其他专有知识产权相关文本
- 产品图片或图形
- 企业标志
- 技术文件中提及的各个品牌的商标声明
- 公司信息、联系电话、网站 URL 等
- 免责声明和披露文本
注意：不要在封面上添加页码
2. 目录
准备目录 (TOC) 时，通常从小写字母的页码开始。通常，您以“iii”或罗马数字“3”开头，因为封面通常需要两页。
接下来，就来 章节标题 和页码。缩进章节标题和页码。子部分也缩进。目录中的所有条目都应该有一个页码，用户可以在其中找到特定信息。
在标题之后，包括 数字列表 和 页码， 此 表格清单 和页码， 其他清单 （例如作者），然后是 词汇表, 附录，附录及 索引标题.
词汇表 通常有两栏用于项目和描述，并将包含内容中包含的技术术语、缩写词和首字母缩略词。
3. 后盖
后盖包含 企业标志， 一切 企业联系方式，并 版权声明 和 日期.
提高技术写作能力的 10 个技巧
研究人员和工程师通常会创建技术文档。他们必须精通沟通，以确保用户能够理解他们想要传达的内容。但通常，他们不具备编写最终用户肯定能欣赏的技术文档的写作技巧，因为他们的理解水平不同。
如果您专注于技术写作，则具备创建功能性文档的技能，并拥有高水平的技术专业知识和理解力，能够以连贯、简洁和清晰的方式表达信息。
以下是有关如何提高技术写作技能的一些建议。
- 想想目标受众
技术写作有特定的受众。您应该考虑他们是谁以及他们需要知道什么和做什么。为读者提供一组逻辑步骤，并解释他们在每个步骤中需要做什么。
- 了解产品的里里外外
您必须彻底了解产品，这样您才能用简单的术语分享复杂的想法和概念。从客户那里获取所有信息，进行额外的研究，咨询专家并阅读相关信息。这样做直到您准备好用易于理解的语言准确地解释内容。
- 思考正确的结构
创建信息传递的逻辑结构。想想用户遇到问题时需要做什么。想想所有可能出错的地方并给出准确的解释。确保想法自由自然地流动。如果有多个部分，请使用过渡来提高可读性。
- 正确布局文本
正确的布局使文本易于浏览。正确的布局使文本更容易理解。请记住，有些读者会浏览文档并选择他们需要的要点，而另一些读者则想要阅读所有内容。
- 添加插图
插图可以打破阅读连续文本的单调感。可能需要插图来识别产品的部件，例如笔记本电脑。您可以使用图表、照片、插图、图表和表格。但请谨慎使用它们，并确保用户在阅读相关文本时可以参考它们。
- 提供例子
示例将您所掌握的信息与现实联系起来，将想法转化为实际的东西。添加视觉效果可以帮助解释各种情况。
- 增强可搜索性
确保读者可以使用目录或索引轻松找到相关信息。 TOC 是整个文档的路线图。该索引对于搜索特定信息也很有帮助。
- 与读者联系
人们会使用您的文本，因此请使用对话风格。以第二人称写作，这也使您的文字更易于阅读。尽可能使用主动语态和现在时。请记住，读者会有不同的理解水平，因此使文本易于理解是很实用的。
- 阅读并修改
即使您是主题专家，也请务必阅读并修改您的文本。使用编辑器和校对器将有助于在提交之前测试文档并发现其中的错误。
- 得到反馈
反馈将有助于提高您的技术写作技能。您会知道您的文档是否有帮助，他们是否理解信息，或者他们的问题是否可以从您的文本中找到解决方案。建设性的批评和负面反馈将为您提供提高写作技巧的机会，因为其他人可以看到您自己看不到的错误和其他不必要的写作模式。
您需要翻译技术文件的帮助吗？
技术文档需要主题专业知识，而电子翻译服务可以轻松为您提供专家。我们的译员都是母语人士，拥有翻译 200 多种语言的技术文档所需的多年现场经验。您可以给我们发电子邮件： 联系@etranslationservices.com 或者立即致电 (800) 882-6058 获取免费报价或更多信息。
