良好技术报告的品质
技术写作是每个人职业生涯的重要组成部分。编写好是困难和耗费时间和有关技术学科技术的方式写，甚至变得更加困难。人们写作提出项目，要记录自己的行动，帮助其他了解研究，分析和解决问题，描述程序和对象。如果做得好，技术写作是一个令人兴奋的，实现的经验，但如果做得很差，它令人沮丧，甚至有害的职业发展。以书面形式的技术性基于以下几点
有六个基本技术写作的属性：
- 清晰
- 准确性
- 全面
- 无障碍
- 简明
- 正确性
1。清晰
技术文件必须传达读者可以理解的单一意义。技术写作不清楚很贵。他们在各种员工之间的重要通信链接通常是报告，如果此链接较弱，整个项目可能会受到危害。不清楚
技术写作可能很危险。关于如何操作机械的指示不明确。
2.准确性
不清楚的写作可能导致报告中的许多问题甚至不准确。如果你的意思是写40,000，请不要写400,000。如果您的意思是参考图3.1，请不要参考图3.2。丝毫错误可能会混淆甚至惹恼报告的读者。如果读者怀疑您正在倾斜信息，他们有权怀疑整个文件。
3.全面性：
在技术上写入时，还应提供所有信息，还应提供其背景，并清楚地描述任何过程，或进行具体工作的方法。它还包括结果，结论和建议。
4.可访问性：
这意味着读者可以找到他们寻求的信息的轻松。为了增加可访问性，请在报告中包含标题和列表。内容表，插图列表词汇表和指数是首选。
5.简明扼要：
技术写作意味着有用。文件越长，使用它越困难。即使需要更多的用户时间。简洁起作用，反对清晰度和全面性。解决这一冲突的解决方案是在清晰度，简洁和全面性的要求之间建立平衡。简而言之，在T.W中讨论了主题的各个方面。文件必须足够长，以清晰。它必须给观众目的和对象，但没有额外的细节。通过消除不必要的短语并选择短文字和句子，可以缩短技术写作10-20％。
6.正确
技术报告写作的素质还包括正确的。良好的技术报告也必须是正确的。它。必须没有语法错误，标点符号错误，并且应该具有适当的格式标准。如果报告包含语法错误，则读者将怀疑报告中信息的准确性。技术写作意味着传达信息并说服观众。为了完成这些目标，它必须清晰阳光，易于访问，必须经济和正确。如果你的意思是写“三人：人1，人2和人3参加会议”，但你使用逗号而不是冒号，你的读者可能会想到6人参加会议，而不是3人。
