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

需求分析文档

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.文档前后要具有一致性,清楚各部分元素的联系

相关推荐
数字时代全景窗9 小时前
从OpenClaw、Palantir、SpaceX,看颠覆式创新的四个层次(5)传统财务模型的局限
大数据·人工智能·架构·软件工程
asdfg125896312 小时前
一文理解“架构思维”
java·软件工程·软件开发·架构思维
上海知从科技1 天前
SENT传输协议:汽车传感器数字化通信的最优解决方案
科技·安全·汽车·软件工程·汽车电子
CETOL公差分析2 天前
CETOL 6σ 在汽车工程领域的深度应用:从底盘到三电系统的公差优化实践
汽车·软件工程
琢磨先生David2 天前
未来十年软件工程专业就业前景
软件工程
Terrence Shen3 天前
关于传统软件工程后端技术和当代AI智能体agent构建的harness engineering的一点思考
人工智能·软件工程
Soari3 天前
告别玩具级 Demo!深度拆解 agents-towards-production,用硬核工程把 AI Agent 推向工业级生产线
人工智能·软件工程·llmops·架构优化·genai·aiagent·生产级部署
大迪deblog3 天前
系统架构设计-关键路径真题详解
软件工程
Soari3 天前
AI 编码智能体的“安全防弹衣”:深度拆解 agent-skills,构建百分百受信任的专业技能注册表
人工智能·网络安全·github·软件工程·aiagent·claudecode·agent-skills
Dola_Zou3 天前
医疗装备的出海安全底座
安全·自动化·软件工程·软件加密