编写技术说明的7条准则

nicebaby | 当前状态：在线 总积分：415 2024年可用积分：0 注册时间： 2008-09-09 最后登录时间： 2011-08-09 空间发短消息加为好友: 编写技术说明的7条准则

nicebaby 发表于 2008/10/19 14:05:10 551 查看 0 回复 [上一主题] [下一主题]

手机阅读

虽然我为工程专业杂志写过专栏，但我并不是个纯粹的工程师。事实上，你可以称我为一个“文理兼通”的控制工程律师。为什么这样说呢？因为尽管我能比普通的律师更好地理解你所说的“集成”的含义，但是你永远见不到一条我写的软件编程码。用另一种方式来说，当我的律师身份起不了作用时，你可以和人打赌我不会带着最新的视觉识别技术出现在特许办公区。
　　那么，为什么是我现在在写这篇有关PLC的技术说明，而不是你呢？
　　我来告诉你为什么。编写说明书并不需要科学和逻辑。根据这个原则，我整理出我的“编写技术说明的7条准则”。它同时适用于用户方所写的技术要求说明（通常被集成供应商作为投标的基础文件），和集成供应商所写的技术说明（通常附在协议附件里）。
　　第一：尽可能把决定系统性能的责任推给另一方。作为用户，应该更多地提出希望达到的具体性能说明，并减少设计说明；而作为集成供应商，则正相反。用户所提出的“性能说明”通常规定了承包商必须提供具有某一特定功能的产品，而“设计说明”仅仅规定承包商必须采用某种设计方案，至于这种设计方案能否达到用户的需要则未作详细要求。因此，“性能说明”越多，集成工程师所负担的责任就越大；相反地，“设计说明”越多，这个工程对集成商来说就越像一个搭积木工程，如果设计有缺陷，责任都在用户和设计咨询方这里。当然，不管技术要求说明怎么写，只要最终作为技术说明写进了协议，集成工程师就有责任去实现这些要求。
　　第二：当决定系统性能的责任无法被转嫁，尽可能地把设计责任推给另一方。作为用户，应该将每条“设计说明”都尽可能写得笼统一点，这样，集成供应商就必须担负起进一步设计的责任，并承担设计失误的风险。而作为集成供应商，应该尽可能细化设计说明，让用户和他的咨询顾问来决定阶段性和最终所希望达到的功能。
　　第三：如果上述两项的风险转嫁都不起作用，可尝试加入一条隐性条款，让另一方在安装前和安装调试过程中发现任何问题和可能的隐患都必须提出警告。
　　第四，作为用户，应该尽可能地使用诸如：“最高质量”、“能代表当今领先技术水平”、“完美无缺”之类的短语；作为系统集成供应商，除了在写技术说明本身的要求之外，必须摒弃所有类似的词语，尤以上面提到的几个为甚，如果被要求必须使用类似词语，则可选择“行业惯例或习惯”之类的代替。
　　第五：记得要加入有关试车和培训内容的章节。作为用户，这一章节确保了你的人能从集成供应商处明了系统如何运行，进而了解有关系统的方方面面。而作为供应商，这是获取用户配合和完成项目的保障。
　　第六：尽可能地将与你利益相关的条款写得清晰明确，同时将不利于本方的条款写得笼统模糊（如上述“行业惯例或习惯”的例子）。
　　第七：不管什么事情，都尽可能写的清晰而有条理。尽管像前面所说，有时候写得不那么清楚会更有利些，但是一份乱七八糟的说明会损害所有人的利益，包括你自己。呃，可能有人会得益，我想你猜得到，那就是律师。

1楼 0 0 回复

高级回复 | 发新主题

发表新帖

控制工程师论坛

2016年积分排行