项目组的文档作风.
2005-09-16 11:49
176 查看
项目组的文档风格问题
叫我怎么说?我们项目组里现在充斥着华而不实的文档作风. 做一件事,这样浮燥,这样不脚踏实地是不行的.
写工作文档,规范严格是重要的,但并不是要把简单问题往复杂了搞,不是要把实际问题抽象化,不是要去找一些意义含糊的词语来表达,不是要把一句话可以说明白的意思用一大段话来说得人人都看不懂!
说到工作文档,我想有下面几点要做好,就够了.
一.句法不能出问题:
主谓宾一个也不能少.
如果主谓宾的词语不能确切地,无岐义地表达事实,那么必须用确切的定语\状语\补语成分.
不推荐应用定状补定子句.如果需要的定状补成分是一个子句,那么尽可能分句,在另一句中对于需要限制定的语素进行详细说明.
标点符号不能出错,括号内外的标点要遵守括号标点的惯例.
二.用词:
用词的原则为:
能简单不复杂.
能用常用字词表达,则不用冷僻词.
能用有确切含义的技术名词,则不用俗称或是其他非技术名词.
能具体不抽象.例如要传达"椅子"的概念,就用"椅子"这个词,而不是采用"泛化单式坐恣人体支撑家俱"这样的词,虽然然这样说起来显得很高档.
英文缩写词提供术语解释.
有数值指标的,则不用比较级形容词,如"数据库的容量要达到非常大的容量,在大容量下的性能要在可容忍的限度内."这样的话实际上没有传达信息.而"数据库设计要支持1亿条记录的容量,同在达到1亿条数据时,用身份证号查询记录时,得到结果的时间最长不能大于0.1秒"这样的话就精确定义了信息.
看来我们项目组里有些人需要的不是专业技能, 而是需要补习语文!
叫我怎么说?我们项目组里现在充斥着华而不实的文档作风. 做一件事,这样浮燥,这样不脚踏实地是不行的.
写工作文档,规范严格是重要的,但并不是要把简单问题往复杂了搞,不是要把实际问题抽象化,不是要去找一些意义含糊的词语来表达,不是要把一句话可以说明白的意思用一大段话来说得人人都看不懂!
说到工作文档,我想有下面几点要做好,就够了.
一.句法不能出问题:
主谓宾一个也不能少.
如果主谓宾的词语不能确切地,无岐义地表达事实,那么必须用确切的定语\状语\补语成分.
不推荐应用定状补定子句.如果需要的定状补成分是一个子句,那么尽可能分句,在另一句中对于需要限制定的语素进行详细说明.
标点符号不能出错,括号内外的标点要遵守括号标点的惯例.
二.用词:
用词的原则为:
能简单不复杂.
能用常用字词表达,则不用冷僻词.
能用有确切含义的技术名词,则不用俗称或是其他非技术名词.
能具体不抽象.例如要传达"椅子"的概念,就用"椅子"这个词,而不是采用"泛化单式坐恣人体支撑家俱"这样的词,虽然然这样说起来显得很高档.
英文缩写词提供术语解释.
有数值指标的,则不用比较级形容词,如"数据库的容量要达到非常大的容量,在大容量下的性能要在可容忍的限度内."这样的话实际上没有传达信息.而"数据库设计要支持1亿条记录的容量,同在达到1亿条数据时,用身份证号查询记录时,得到结果的时间最长不能大于0.1秒"这样的话就精确定义了信息.
看来我们项目组里有些人需要的不是专业技能, 而是需要补习语文!
相关文章推荐
- 整理了一份项目组前人写过的关于sql编程规范的文档
- eclipse根据C++项目组提供的WEBSERVICE的WSDL文档生成客户端,打成jar包,供spring项目使用
- 【官方文档】Cocos2d-x xml解析
- 使用doxygen为C/C++程序生成中文文档
- dba 存储过程基本文档
- 【Scikit-Learn 中文文档】Pipeline(管道)和 FeatureUnion(特征联合): 合并的评估器 - 数据集转换 - 用户指南 | ApacheCN
- 第九章:XML文档集成---本章总结
- vb参考文档
- OpenCV训练分类器制作xml文档
- 使用PDFLib生成PDF文档教程
- vs2015打开EXCEL文档范例及其注意事项!!!
- iOS Remote消息推送学习文档一篇足以
- 【Scikit-Learn 中文文档】成对的矩阵, 类别和核函数 - 数据集转换 - 用户指南 | ApacheCN
- 关于电子文档格式标准的几点看法
- RFC文档中文版地址
- 比较两个文档中的文字的区别
- jquery ui 文档使用总结
- 四种生成和解析XML文档的方法详解(介绍+优缺点比较+示例)
- IOS xcode 离线帮助文档安装和安装路径
- scikit-learn 中文文档-模型持久化-用户指南|ApacheCN