hakin 发表于 2017-6-4 14:44:57

协议文档的编写原则

#### 原则

1. 准确(推导结果是正确的)
        * 描述要有主体,不要用修饰性词语指代,导致主体被隐含
        * 范围定义要明确

2. 完整(必要的逻辑关系描述清楚)
       

3. 精确,简明(保证条件唯一)
        * 精简,不要啰嗦重复,这会增加不必要的理解
        * 精准包括,使用更容易理解的词替换需要思考的词

4. 强调突出(突出说明对比的重点)
        * 与精简相对的是,刻意的突出重点
        * 强调时,有时针对同一个事情,还需要重复说明

5. 有条理(逻辑保证有序,且便于理解)
        * 逻辑顺序
        * 时间顺序

郭庆帅 发表于 2017-6-4 18:19:45

赞,对我有帮助
页: [1]
查看完整版本: 协议文档的编写原则