收藏官网首页
查看: 28496|回复: 1

[讨论] 协议文档的编写原则

3

主题

6

帖子

56

积分

注册会员

Rank: 2

积分
56
跳转到指定楼层
楼主
发表于 2017-6-4 14:44:57 | 只看该作者 回帖奖励 |倒序浏览 |阅读模式
免费使用STM32、APP自动代码生成工具
#### 原则

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

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

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

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

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

36

主题

308

帖子

70

积分

注册会员

Rank: 2

积分
70
沙发
发表于 2017-6-4 18:19:45 | 只看该作者
赞,对我有帮助
G3机智云物联网云服务 287087942
有什么疑问,可以在论坛,qq群(优先在论坛哦,避免重复造轮子)
在论坛提问的回答率是100%!!!!!!!!
希望和大家一起交流学习.
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

加入Q群 返回顶部

版权与免责声明 © 2006-2024 Gizwits IoT Technology Co., Ltd. ( 粤ICP备11090211号 )

快速回复 返回顶部 返回列表