Java web 项目技术文档目录结构

近期项目比较忙,没有更新文章,现在到了项目收尾阶段,正好在准备技术文档,所以把这个技术文档的目录和大家共享一下。

下面目录是我在参考了几个项目文档后自己总结出来的,每个章节之间不是递进关系(如四是对三的进一步详细描述)就是并列关系(如果4.4.1 和 4.4.2),整个目录内容如下:

[JavaWeb]项目-开发文档
目录审核使用-v0.0.1
XXXX科技股份有限公司


目录
一、引言	3
1.1 目的	3
1.2 范围	3
1.3 定义关键词	3
1.4 读者对象	3
1.5 参考资料	3
二、项目结构描述	3
2.1 系统设计	3
2.2 系统关系	3
三、架构设计	3
3.1 架构分析	3
3.2 组件关系	3
四、项目设计	4
4.1 模块设计	4
4.1.1 xxx模块	4
4.1.2 xxx...	4
4.2 角色设计	4
4.2.1 xxx角色	4
4.2.2 xxx...	4
4.3 用例视图	4
4.3.1 xxx角色用户	4
4.3.2 xxx...	4
4.4 逻辑视图	4
4.4.1 xxx功能点	4
4.4.2 xxx...	4
五、持久层设计	4


一、引言
1.1 目的
1.2 范围
1.3 定义关键词
1.4 读者对象
1.5 参考资料
二、项目结构描述
【项目综述,阐述项目预期目标和用户范围】
2.1 系统设计
【根据项目预期目标,做系统设计】
2.2 系统关系
【根据系统设计的结果,阐述系统间的关系】
三、架构设计
【根据系统设计的结果和系统间的关系,确定开发使用的架构】
3.1 架构分析
【主要架构组件的分析,阐述使用原因】
3.2 组件关系
【为实现系统功能,阐述组件间的关系】
四、项目设计
4.1 模块设计
【根据项目预期目标,做模块设计】
4.1.1 xxx模块
【根据模块设计结果,阐述每个模块的负责范围】
4.1.2 xxx...
4.2 角色设计
【根据项目预期目标和用户范围,做角色设计】
4.2.1 xxx角色
【根据角色设计结果,阐述每个角色的可使用模块范围】
4.2.2 xxx...
4.3 用例视图
4.3.1 xxx角色用户
【根据角色设计结果,阐述拥有某个角色的用户在该项目中的操作流程。操作过程中涉及到各个模块的功能点】
4.3.2 xxx...
4.4 逻辑视图
4.4.1 xxx功能点
【根据用户操作涉及到的功能点,设计功能点的实现逻辑】
4.4.2 xxx...
五、持久层设计
【根据项目设计的结果,做持久层设计。作为功能点实现的持久层支撑,并支持项目预期目标的完成】

猜你喜欢

转载自blog.csdn.net/u013276512/article/details/84528978