提供准确和及时的项目文件在我们的世界中至关重要。每个项目可能需要在寿命期间创建各种文档，并且每个文档可能有几个发布阶段。当在技术上审查您的下一个项目的工程文档挑战时，我建议从一系列简单的问题开始问自己。答案将指导您在适当的审查中。
免责声明：我不是编辑，但我在20年以上的工程职业生涯中撰写和技术审查了数百个文件，并挑选了一些可以帮助您节省时间并产生更好的质量项目文件的东西。
- 这是第一次审核文档吗?
- 是你已知的主题吗？
- 您在评论中的角色是什么？您是工程技术评论员吗？你是技术作家吗？您是验证或优质代表吗？
- 审查的哪个阶段是文件？
- 这是一个初步草案，释放供应商开始或继续工作吗？
- 这是为了最终批准吗？初始释放？运营释放？
这是第一次审核文档吗?
如果答案是肯定的，那么遗憾的是，您需要阅读并查看整个文件。如果答案是否定的，那么它取决于审查的阶段，您应该审查多少文件。
是你已知的主题吗？
我认为你对主题越熟悉，你应该花在复习上的时间就越多。同上面第一个问题一样，为审查文件所作的努力应与文件发展的阶段相称。例如，技术作者审查工程师编写的工程文档时可能不理解主题的技术内容，但通过知道如何简单地传达复杂的思想以及提供语法上的帮助，为审查带来价值。
当审查一些没有意义的东西时，在那一点上发表评论，然后与作者进行澄清。他们应该能够解释它，而这种解释可能会改进用来使其易于理解的废话。然而，在某些情况下，由于其技术性质，必须保持复杂性。这是可以的，因为文档的受众是技术性的。这就引出了下一个问题。
您在评论中的角色是什么？您是工程技术评论员吗？你是技术作家吗？您是验证或优质代表吗？
这些（和其他）角色中的每一个都是审查周期的一部分，因为每个审稿人都会带来与表基础不同的作用。由于本文是关于工程技术审查，我将主要集中在这一角色。执行工程技术审查取决于正在审查的文件类型。功能规范或配置规范包含许多技术术语，需要了解技术内容以及文档的结构。文件是为GAMP5流程编写的文件吗？它是否构建了S88批处理上下文？了解这些将有助于您通过了解文件的期望，并最终项目提供帮助。
将此与审查标准操作程序(SOP)进行比较。SOP是为终端用户编写的操作设备或运行流程的一系列步骤。这类文件的工程技术审查级别需要一些过程知识，如果SOP涉及自动化，还需要一些自动化知识。应评审SOP，就像评审人员正在执行程序一样。检查SOP的步骤，确保其符合逻辑。
审查的哪个阶段是文件？这是一个初步草案，释放供应商开始或继续工作吗？这是为了最终批准吗？初始释放？运营释放？
根据审查阶段，每个选项的审查流程更改。执行工程技术审查文件的初步草案，以发布供应商开始或继续工作应该彻底才能捕获大型票据，以便供应商理解项目的范围而不会陷入困境的语法校正在更加最终版本中清理干净。此阶段的对象是通过对范围的坚定了解，将供应商与项目一起运行并运行。
每次审核都要遵循的标准基本规则
每一个问题都需要不同程度的工程技术审查，并且在许多方面相互交织。这里有一些标准的基本规则，应该遵循每一次审查。
- 当使用Microsoft Word时，确保开启Track Changes功能。其他软件可能有类似的方法来跟踪更新，应该在适当的地方使用这些方法。我知道Microsoft Excel版本的Track Changes还有很多不足之处，所以我通常会突出我评论过的单元格。
- “不要出汗小东西，”在书中引用不要出汗小东西，第p。。这都是小东西审阅一份文件不是凭空发生的。通常会有来自各种背景和工作职责的多学科审查人员，他们会发现你没有发现的错误。
- “不要让完美成为善的敌人。”在我们最近完成的三年项目中，这位伏尔泰报价由同行和朋友借用。如果在一份传达的文档中有任何武器，则在技术上是正确的，但可以措辞稍微好一点（即话语），抵抗有效的变化。它足够好。如果您认为它值得评论，那么就会接触作者。如果令人困惑，那么与作者交谈可能会清除它，而不必改变。
聪明地了解正在审查的内容。每个人的时间都很短，因此开发一些关于如何审查文件的准则将是继续成功的关键。了解您所在文档审查周期的哪个阶段，您是否已经在此之前看过该文件，以及您在审查过程中的角色是什么，将有效地提供有效和彻底的文档审核。尽可能询问作者的问题，并抵制改变的变化。记住，“不要让完美成为善的敌人。”
Mark Foreworthy是高级项目工程师优越的控制,一个E技术组公司。E技术集团是一个认证的成员控制系统集成商协会(相)。欲了解更多关于E科技集团的信息，请访问它在工业自动化交易所的简介。
