软件工程文档规范要点总结

需求分析文档

1.目标用户应该体现为用例图里的执行者(执行者要标明是哪一类用户)

2.用例模型由功能概述得到,用例顺序图由基本交互过程得到,分析类图由顺序图得到

3.执行者和用例之间的关系:执行、触发、驱动

用例之间关系:包含include、扩展extend,箭头方向(include朝向子用例,extend朝向主用例)

4.基本交互过程口语化(比如把"点击"等词汇换成"选择")

5.分清前置条件和触发条件(例如软件运行启动、打开页面属于前置条件,用户选择某个操作属于触发条件)不要把前置条件和触发条件放在基本交互动作里

6.扩展交互动作是异常或意外状况,编号要从基本交互动作里选取,内容在其基础上扩展

7.顺序图需要标注出三种分析类:边界类<<boundary>>,控制类<<control>>,实体类<<entity>>

类名加下划线

8.用户不能和控制类直接交换信息,不允许跨越控制类

9.类的命名主要为名词,命名要具体

10.边界类最后不一定是给用户发消息,应该是边界类给自己发消息显示信息

11.用例模型左边是主动执行者,右边是被动执行者

软件设计文档

1.命令元素:方法; 动态/输入元素:属性;

静态元素不放在类图里,但要在界面外观设计图标出

2.在界面外观设计用特殊标注标出不同元素(同一类型用同样的颜色标志标出)

3.设计类不区分边界类、控制类、实体类,因此不在设计图中表示

4.分析类的职责映射给若干个设计类,设计类的大致框架在分析类的基础上得到

5.只要有实体类就有数据模型,数据模型的设计根据软件所需的Table,实体类转过来的要有key 表示关系用foreignkey,表和表之间的关系映射,通过相同的key和foreignkey来表示

6.数据模型中多对多关系中间还要有一个Table建立两个Table的联系

7.设计阶段顺序图传递的消息、类的命名等都为英文,为编码阶段做准备

8.方法带参数的要标明参数

文档通用

1.目录生成和更新页码,要能和实际内容对应上,图表的标号表示第n章的第i张图/表,表示为图n-i

2.每张图都要有图的编号/图注,图的引用(在正文中"如图x-x所示")

3.图注和图不能跨页

4.正文字体和行间距保持一致

5.文档前后要具有一致性,清楚各部分元素的联系

相关推荐
雾江流4 小时前
MinimalWalls v1.9.8 | 提供高质量简约壁纸,支持一键下载、收藏和自动更换等功能,界面干净并支持深浅模式切换
软件工程
0和1的舞者7 小时前
网络通信的奥秘:HTTP详解 (七)
服务器·网络·网络协议·http·okhttp·软件工程·1024程序员节
玖涯菜菜子8 小时前
申请软著,怎么快速整理软件源代码
软件工程
HLJ洛神千羽13 小时前
C++程序设计实验(黑龙江大学)
开发语言·c++·软件工程
云知谷1 天前
【C/C++基本功】C/C++江湖风云录:void* 的江湖传说
c语言·开发语言·c++·软件工程·团队开发
木霖森771 天前
软件工程入门学习
学习·软件工程
曦樂~2 天前
4 信息收集&建模和工作流程
项目管理·软件工程
曦樂~2 天前
1系统分析与设计及 IT 项目管理
项目管理·软件工程
郝学胜-神的一滴6 天前
深入解析C++命令模式:设计原理与实际应用
开发语言·c++·程序人生·软件工程·命令模式
紫金桥软件7 天前
组态软件和实时数据库区别大吗?
数据库·物联网·软件工程·scada·监控组态软件