项目规格文件的重要性

留下项目规格说明空白或TBA会给项目带来麻烦。

由MAVERICK Technologies控制系统工程团队负责 2012年6月26日

关于创建法律合同的主题已经写了很多,通常包括这样的陈述,“好的合同造就好的客户”和“好的合同导致好的客户关系”。合同很重要。除了陈述法律和财务要求外,合同还规定了为客户所做的工作。与合同一样重要的是,需要适当的规范来清楚地确定如何满足合同需求。

我们写这篇文章是为了提醒我们的同行关于规格说明对任何工程项目的重要性,并向任何潜在客户解释我们知道如何交付预期的东西。当我们说“我们明白了”时,功能规范就是定义“它”的地方。

也有很多文章为项目经理提供了如何运行项目的建议。这篇文章并不是要总结这些建议。我们不能很好地做到这一点,因为我们不是项目经理。相反,我们是在不同项目团队中工作过的工程师,有一些经验可以分享。

我们所从事的大多数项目都受益于编写良好的规范中提供的良好任务定义。然而,由于缺乏这样的定义,一些项目遇到了麻烦。许多困难可以通过编写和审查功能规范来避免,以提供关于如何满足项目技术需求的清晰而明确的描述。(抱歉,如果这听起来重复或说教,但到目前为止,你可能已经意识到我们对这个问题的强烈感受。)

在本讨论中,将使用假设项目的操作员显示需求来说明需要的示例。

功能规范描述了交付的系统必须做什么,类似于项目的合同,但是更详细。这是任何项目最重要的规范(依我们拙见)。它可能包含过程叙述或操作序列。它可以用I/O列表、接口规范、逻辑序列图、配方表、过程计算,甚至伪代码进行扩充。这些细节有时在单独的详细设计规范中提供,这超出了本文讨论的范围。

对于我们的显示示例,功能规范可以描述不同颜色的重要性,提供用户登录安全级别,并枚举操作员显示屏幕,提供每个屏幕内容的描述。

合同可能包括“为操作员提供带有图形屏幕的操作员显示器,供操作员使用以控制过程”的要求。这样的需求必须在项目开始时扩展为对筛选开发人员有用的细节。如果开发人员只按照一般的指示进行,而没有进一步的定义,那么生产出来的操作员显示屏可能与最终用户所设想的大不相同。理想情况下,定义是在开发开始之前完成的。(下面讨论的原型设计是一个例外。)

必须与流程所有者一起审查功能规范,以确保开发人员和流程所有者都同意要交付的系统,包括我们示例中的屏幕。这在开发工作进行得非常深入之前是很重要的,但是在最初的讨论中需要一些初步的开发作为参考,例如原型屏幕。

审查功能规范的任何会议、网络研讨会或电话会议不仅应包括流程所有者公司的设计或流程工程师,还应包括将使用该系统的单个操作人员和技术人员。对于我们的操作员显示示例,与适当的参与者进行这样的审查将很快识别出用户的红/绿色盲使得难以区分绿色泵(表示它正在运行)和红色泵的情况。审查也会发现关于红色的意义的任何混淆。红色是否表示关闭或故障?最好在所有20个左右的屏幕被开发出来之前识别并解决这两个问题!

关于避免返工的最后一部分有助于说明跳过涉及功能规范的项目开发周期中的步骤所带来的财务后果。如果开发人员没有一组商定的前进命令,那么很容易花几个星期的时间开发系统的各个方面,例如我们示例中的屏幕,其中包含流程所有者不喜欢的内容。

这里表达的想法并不新鲜。但是他们经常被遗忘,这就是为什么我们今天花时间写这篇文章来提醒你。这也可以为您提供明天可能使用的文档,或者当您在将来的讨论中需要备份时,当有人试图说服您不需要功能规范,成本太高,没有价值,或者,好吧,借口列表可能会很长。

为任何项目生成一个完整的、写得很好的功能规范是很容易证明的,而忽略它是有风险的。在与流程所有者的初步会谈中,描述对这样一个文档的需求,并进行彻底的审查,这表明你的专业性。它表明您有方法在满足最终用户需求的同时避免困难。它提供了一份文件,上面写着:“这是我们听到你要求的东西。”另外,你也有机会问:“这是你想让我们为你做的吗?”

本文由MAVERICK Technologies的控制系统工程团队撰写,MAVERICK Technologies是一家领先的系统集成商,为制造和加工行业提供工业自动化、运营支持和控制系统工程服务。MAVERICK在各种领域提供专业知识和咨询,包括工业自动化控制,分布式控制系统,制造执行系统,运营战略和业务流程优化。该公司提供全方位的自动化和控制服务-从PID控制器调谐和HMI编程到作为主要自动化承包商。此外,MAVERICK还提供工业和技术人员配置服务,安置现场自动化,仪表和控制工程师。