文档编写注意事项

1、确立项目名称(响亮的英文名)

注重逻辑性

版本更新要与项目名称相同

术语与缩略语

2、目录及架构

简介

应用场景

  标准的需求描述规范

  3、关键概念(业务逻辑,描述核心思维)

  4、功能框图(技术描述功能,按逻辑输出)

  5、部署角色

  6、功能约束(不能干的事,数据传入格式等)

3、系统用例

4、功能定义(用例的具体实现)

 

5、非功能性需求(质量控制)

  性能:

  可配置性:
  可靠性:

 

posted @ 2019-04-28 15:09  jiuyang  阅读(515)  评论(0编辑  收藏  举报