编写设备规格说明书是每个装配项目的关键,但经常被忽视。设备规格是发出询价的前奏,经过适当的修订,成为设备实际采购订单的一部分。

编写规范是每个组装项目的关键,但经常被忽略。工程师们讨厌这个任务,觉得它既乏味又困难。他们认为这与工程没有什么关系。结果,他们经常做得很差,或者根本不写规范。实际上,编写规范是完成工程中最关键的部分的最佳机会,这部分是预测和避免问题的部分。那些花时间进行计划、着眼于大局并传达期望的工程师将为成功安装满足组织中每个人需求的系统奠定基础。

什么是规格?

说明书是工程工具,是沟通工具,是销售工具。除了描述要购买的设备外,它还必须确定该组织与该设备相关的需求。

然后,写出规范的第一步是了解您的受众是谁以及他们的需求。此过程将使您可以将解决方案纳入其规范中的疑虑。

您的受众是对设备兴趣的所有人:上层管理,采购经理,项目经理,项目工程师,机器制造商,产品设计工程师和支持人员,包括运营,质量,设施和维护。由于本组织的特定利基,这些人将存在偏差。上层管理层将希望保证他们正在做出良好的投资。项目经理将想知道设备是否会做它应该做的事情,以及规范是否包含适当的细节来控制项目的范围和预算。操作将想知道新设备如何影响它们。他们需要多少运营商?需要什么培训?

你是一名工程师,你说,而不是作家或外交官。别担心。编写规范主要是工程任务。如果您进行工程权,并涉及其他组织,您将成功。

开发规范

我们都听过这些可怕的故事。采购部抱怨供应商没有足够的信息来报价设备。投标已经收到,但管理层还没有“买账”。一旦合同被授予,卖主就要求更多的钱使设备满足最低要求。设备已经安装好了,但它不工作。运营部门抱怨运营起来太难了。维修人员抱怨说维修太困难了。质量证明该设备生产出的产品质量不稳定。

作为规范的作者,您的目标是避免这些问题。当然,即使是一个完美的规范也不能解决世界上所有的问题。然而,造成这些问题最多的一个因素是缺乏预先的工程设计。

任何工程师的工作可以总结如下:

  • 确定解决问题的需求。
  • 设计一个解决方案。
  • 把设计记录下来,这样别人就可以建造它了。
对于一个正在编写规范的工程师来说,这份工作是不变的。您需要确定与设备相关的组织需求,找出设备需要做什么来满足这些需求,并以规格说明的形式写下思考过程。

在编写规范时,如果您能与涉众(包括您的供应商)建立团队精神,这将是一个巨大的优势。如果你让他们参与进来,他们将更有可能将注意力和创造力投入到你的需求中。他们也会提前告诉你他们的需求——当你可以把他们的需求写在纸上并设计出解决方案时——而不是之后以投诉的形式告诉你。

记住这一点,通过确定组织中的所有涉众来开始您的规范开发过程。确保你在早期就和他们谈过。尽可能多地获取数据。

然后做一些工程。弄清楚设备需要做什么。现在还不用担心编写规范。把自己限制在图表、表格、图表和项目符号列表中。准备一份陈述或总结文件。本报告应包括:

  • 主要要求和目标,子弹形式。
  • 显示每个步骤的输入和输出的过程框图。
  • 显示控件需求的框图。(如果有重要的软件组成部分,则将硬件和软件分开。)
最后展示设备将如何满足要求和目标。列出你或公司需要解决的问题和未知数。

在会议中提供此信息并记录所有反馈。如果会议成功,您将获得许多有价值的信息。你会发现你的许多假设都是错误的,你的图表将被淘汰。这很好,因为现在你正在达到某个地方。你也会得到另一个好处:参加会议的人将理解你想要做的事情并将关心结果。他们会在你身边。

多做点工程。根据会议的反馈修改你的演示文稿。

现在起草你的规范。如果您在这一点上做得很好,那么文档实际上会自行编写。留下一些未知数和未决问题是可以的。把它们记在课文里就行了。

传阅规范以征求意见。让人们彻底阅读你的文档是很困难的。根据设备的复杂性和未解决问题的数量,可能需要召集一次会议,让人们通过草案。

当所有未解决的问题都得到解决后,您可以将规范发布给供应商进行报价。

与供应商磋商并审查他们的提案。通常,供应商将有一个好主意,但它并不完全符合规范。或者,供应商将有问题需要在规范中添加或澄清。一旦您解决了他们的评论,传送新副本并获得最终出价。

授予合同后,将规范保存为新的信息曲面。这样,您可以使用该文件来构建彻底和客观的测试程序,以便最终接受设备。

内容和组织

你必须记住,规格书是对某些设备的功能描述。它应该描述你想让设备做什么,同时给如何做尽可能多的自由。完成这一任务的最佳方法是将设备视为一个黑盒子,并描述其输入和输出。

任何规格书的核心都是设备将做什么的图表。顶级图将把整个系统显示为一个黑盒,以及输入、输出和一些关键需求。当您描述输入和输出时,请确保同时包含材料和控制元素。

顶层图是一个有价值的起点,但它没有足够的细节来完全描述设备。您将需要创建一个二级图表,将设备划分为主要功能部分。

有两种类型的图可以用于此目的。最常见的方法是过程方法。将流程分解为其组件步骤,并在图中为每个步骤放置一个块。显示每个块的输入和输出。一种不太常见的方法是原理图。当过程简单明了,而重要的任务是描述设备的属性时,这种方法是最好的。如果使用这种方法,请确保将设备划分为子系统,并为每个子系统贴上标签。

您还需要一个控件框图。这个框图应该显示主要的控制元素,它们控制什么以及它们如何相互连接。一旦有了框图,就可以开始编写规范的三个部分了。它们是“系统概述”、“系统元素的细节”和“控制策略”。

“系统概述”将包含顶层框图,并描述输入、输出和顶层需求。顶级要求包括生产速度、质量措施和布局要求。

“系统元素详细信息”将包含第二级图表。图中的每个元素都有一个分段。这些小节在结构上与系统概述相似。它们将描述每个元素的输入、输出和其他需求。

“控制策略”将包含控制框图。本节应涵盖控制功能、控制面板布局和要求,以及安全联锁。

在您写时,请考虑如何确定设备是否符合规格。如果您陈述生产率,请在几个时间段,以及如何处理拒绝和停机时间的状态。对于焊接或分配等工艺,陈述您将使用的质量措施。参考行业规格如果存在。

编写完这三个部分后,就可以将它们组合成规范了。

从目录开始。这将告诉读者在哪里寻找具体的信息。把关于给定主题的所有信息放在一个地方,不要在其他地方重复。这将使您在以后修改文档时很难保持一致。

你需要涵盖以下主题:

设备的目的。简要说明设备的用途以及组织需要它的原因。上层管理人员将阅读本节和“系统概述”部分,但可能不会再多了。

验收测试。说明接受标准以及如何核实它们。

文档和培训。描述您的运营和维护组织需要什么。

设备的标准。通常你会参考其他公司的文件,如布线标准、批准的供应商清单、图纸标准、连接和紧固标准以及材料标准。

连接和安装。说明设备如何与其他设备连接是很重要的,这样读者就不会做出错误的假设。任何界面的图纸或草图都是有帮助的。在许多情况下,您将无法精确定义接口,因为其他设备尚未设计。在这种情况下,您应该确定接口并对其进行足够的描述,以便供应商能够引用该接口,即使他不知道如何设计它。这个主题可以在它自己的部分中处理,或者作为“系统概述”和“系统元素详细信息”部分的一部分。

定义。您应该定义所有具有一般技术背景的读者可能不知道的技术术语。这包括你所在行业的缩写词和专业术语,这些是大学基础课程中不会教的。

参考文献包含一个列出所有参考文档的部分是个好主意。这包括零件图纸,布局图纸,公司和外部标准以及规范中引用的其他文件。如果引用的文件可能经常变化,例如零件绘图,则指定“最近修订”而不是实际修订级别是一个好主意,因此每次有人发出未成年人时都没有更改规范绘图变更。

思考风格

你应该选择一种精确而明确的写作风格。无聊也没关系。事实上,你应该刻意地变得乏味和详细。人们阅读你的说明书不是为了好玩。他们阅读它是为了获取信息。

当你想要做某事时,养成使用“shall”这个词的习惯。描述外部因素时使用“will”。避免使用“应该”,因为它暗示某事是可选的。对一个选项的要求描述为:“供应商应提供一个……的选项。”描述一个偏好:“设备可能包括a或B;一个是首选。”

你应该重复单词和短语,而不是使用代词。这将消除最大的潜在模糊区域。

所有的段落数。你可以用电脑自动给段落编号。

对文件进行修订控制。无论何时进行更改,请在修订控制部分记下它们。为了保持编号的完整性,用“已删除”这个词替换已删除的部分或段落。如果你要添加段落,把它们添加到相关的部分或分段的末尾,这样前面的段落就不会被重新编号。

最后,保持简单。如果你发现用几句话很难清楚地描述某件事,那你可能试着太详细了。问问你自己,你是在描述功能,还是在告诉读者如何解决问题。如果是后者,那么您已经从规范活动转向了设计活动。

如果你对控制不舒服,控制工程师可以帮助你创建一个。如果您遵循这种方法,您将发现您可以享受编写规范的乐趣!