更好的项目文件

项目文档是事后才想到的吗?项目的文档阶段是否看起来是一个乏味的过程?客户是否理解正确定义的重要性?文档可能是项目中最重要的部分。

作者:Jeff Haywood, Maverick Technologies 2015年9月29日

用于定义工厂流程和自动化系统功能需求的项目文件。这将使客户和工程师都有机会在编写任何代码之前,从心理上了解系统应该如何运行。它为协作和审查提供了机会。正确的定义总是会让你的项目更成功。

你是否曾经参与过这样的项目:你只拿到一张P&ID图,然后被告知:“我想让你编写这个程序。”项目定义可能是一个拥有满意客户的成功项目和一个你只想结束的噩梦之间的区别。虽然项目定义有多种形式,但最终的结果应该是向客户和工程师提供有关过程如何工作以及需要哪些功能的信息。定义可以是用户需求规范、功能规范、详细设计规范或控制叙述的形式。项目定义可以由客户和工程师提供。所有各方都应该有适当的时间来审查文件并根据需要进行更新。这些文件应被视为动态文件,将在整个项目生命周期中根据需要进行更新。

一般会使用用户需求规格书及/或功能规格书,从高层次上定义过程及功能。这应包括工艺说明、要控制的设备和一般工艺操作。它还应该包括硬件、软件和功能需求。详细设计规范和/或控制叙述将被编写,以给出自动化系统的非常详细的视图。设计这些文档的目的应该是让工程师完全了解要编程的内容。这些文件应包括被控制过程的一般描述。它们将包括被控制设备的定义,包括每个设备的特征,例如,反馈和故障位置。详细设计文档应包括所需警报、权限和联锁的信息。您还需要包含操作流程所需的步骤。这个过程是如何开始的? How does the process stop? Will the process change modes while running? What should happen if the process needs to stop immediately? You will also want to include any parameters that will need to be entered to operate the system.

我们花在定义上的时间越多,我们花在重新编程上的时间就越少。总是花时间与客户和项目团队一起审查项目定义。请记住,项目定义应被视为一份活文档,并应根据需要进行更新。记得与客户一起检查所有更新。如果我们在定义时尽职尽责,就可以避免噩梦。

这篇文章是杰夫·海伍德写的。杰夫是一名高级工程师特立独行的技术是一家领先的自动化解决方案提供商,为过程工业提供工业自动化、战略制造和企业集成服务。Maverick在各种领域提供专业知识和咨询,包括工业自动化控制、分布式控制系统、制造执行系统、运营战略、业务流程优化等。

Maverick Technologies是一家2015年7月20日的会员