论坛徽章:: 0

电梯直达

1楼 [收藏(0)] [报告]

发表于 2006-08-30 11:05 |只看该作者 |倒序浏览

我实在不知道该发在哪个版块，因此只好放在这里。如果有合适的版块，移动过去好了。谢谢。

是否有必要建立一个针对中国工程师思维习惯的文档标准？统一中国工程师文档的格式。让这类文档既适合甲方管理自己的系统，又适合乙方的工程师全面的考虑系统的实施。同时，还能给新进工程师以更加容易理解的帮助，不让大多数新进工程师在门外转悠2，3年才算入门？

中国作为计算机产业大国，在开发上，我们很遗憾，到今天我们也无法和美国人比拼任何东西。几乎所有的软件标准和开发标准都来自于美国和欧洲。然而，在使用上，我们却仍然要全盘接受来自美国的文档习惯，我发现大部分工程师都不是那么的适应。因此，如何写一篇文档，既让他符合中国人理解问题的习惯，又能保证逻辑和技术上的严谨性，则成为一个至少摆在我面前的课题。

我在CU，在工作上阅读过大量各种各样中国人写的文档。然而，说句实在话，这些文档有些虽然在技术上有所保证，但在逻辑上则经常有极大的跳跃。而逻辑上有的做的很好，但又过于循序渐进了。同时，这些文档有很多在术语，机制上的描述，经常会出现非常重大的错误。有很多文档甚至对工程师们产生了误导。

经过了数年的工作，我还注意到，中国每一个工程师其实都有他们自己的风格。这种个性化的风格用于开发当然是很好的经验，而用于实施，则经常成为一个阻碍工程师间交流的巨大鸿沟。经常有这样的事情，其实已经完全了解这个软件的功能了，可是在别人的嘴里说出来，则完全变成了一个新的东西。也许别人理解有误，然而为了沟通，我们不得不花费数天时间去理解别人的语言习惯或者术语习惯。从而产生很多无用功，耽误很多大好的时间。

下面我抛砖引玉。

作为工程师，说实在话，我绝对不属于一流，工作10年，对计算机理论的了解程度不过10%。但毕竟动了点脑子，放在这，如果有人认同我的想法，希望能够积极讨论。让我们在中国工程师领域做出一些学术或工作方法上的进展。

1。如何算是学会一种技术。哪些是最迫切要知道的，哪些稍后才需要知道。如果精通，到底需要了解什么才算是精通。

1）通常我们学习一种软件，一种硬件，通常都要面对容量大到上G的文档。而真正学明白的时候，却发现其实没必要这样一篇一篇的去读上千页的英文文档。然而，经过一段时间的使用，我们又会发现，我们缺少一根主线，也正因为如此，我们总是会少考虑很多问题。而这，也正是工程事故的一个主要原因。当我们逐渐形成这一主线的时候，我们又会发现，我们其实已经建立了对此产品的知识体系，也已经做到了触类旁通。

因此，一篇好的文档，应当首先帮助阅读者建立这条主线。例如，磁带库产品，他的真正主线就是容量，磁带机以及与主机连接的线路。了解了容量就可以有效的分配容量，了解了磁带机就能预知这个磁带库的I/O能力，了解了与主机连接的线路，就能够了解磁带库的工作方法与数据保存方法。

在此基础上，我认为文档的第二部分就应该用于介绍磁带库的分支。这里有一个文档定位的问题。通常我会将磁带库的厂商维护文档做一个字典。因为这里介绍了所有单元的更换和所有的错误代码以及错误建议，这不用体现在我自己的文档里。我这里所说的分支，其实是以原文文档的分支规律，列出可能出现的问题。作为厂商文档的有效补充，在实施中有可能达到事半功倍的效果。

2）了解到什么程度才算精通的问题。这里有很多标准，但是想全面的表达出来。则可能非常困难。我想这正是这篇文档精华所在。这需要大家的智慧。

2。文档通常的作用是实施参考。那么，如何才算一个完美的实施呢？怎么实施之后，既不会产生不可预知的问题，也不会给自己带来大麻烦呢？

如果说我们把文档写成字典，罗列所有可能的问题，我们既没有这个精力，恐怕也没有这个能力。那么，我们不如定义一个完美实施这一产品的规范，即所谓标准。

例如，如果我们单独实施一个磁带库，那么只要磁带库自检OK，能够正常ready，正常online，且主机已经可以正确识别磁带机。那么这个实施就算完成了吗？当然不是，磁带库的平衡与稳定是磁带库工作的基础，如何证明磁带库已经稳定的放置在工作位置，是用户考虑不到，而却是你必须要关心的。很多磁带库经常出问题，就在于水平工作不够扎实，造成机械手在运动过程中产生大量能耗，最终缩减了大量的寿命。

那么，我们在文档中就需要规定一些标准。例如水平位置，磁带机检测过程，机械手检测过程，皮带，齿轮的技术参数等等。这通常要设计一个标准表格。

3。文档应该提出管理手段。

很多用户是敬畏他们购买的产品的。因为这些设备，软件动辄价值数百万。然而，如果不让用户了解这个产品，你的产品则很难成为用户心中的核心产品。那么你的产品的地位就得不到应有的体现。在用户支持上，你就会觉得难受，觉得很多工作干不下去。而对于一个好奇的用户，让他随意测试这些核心设备通常都是危险的。这会让你增加很多服务时间。因此，我们其实可以给用户提供一个管理建议。让用户按照我们希望的方式去管理这些产品。而到底该让用户如何管理，则一直是困绕我的课题。

我始终认为，一篇优秀的文档，总是可以让我们的实施时间减少一半以上，让我们实施事故率降低一半以上，也让我们的服务时间缩短一半以上。这样我们可以接触更多的用户，也就更多体现自己的价值。