《XXX软件》设计文档SourceForge.docx

1、XXX软件设计文档 SourceForge时间日志软件设计说明书作者： 冯杰 版本： 0.1 时间： 2011/8/13 目录1 引言 11.1 项目简要介绍 11.2 项目背景 11.3 项目的创新点 11.4 定义 12 任务概述 12.1 目标 12.2 运行环境 13 需求规定 13.1 功能需求 13.2 性能需求 13.2.1 数据精确度 13.2.2 时间特性要求 14 总体设计 14.1 基本设计概念和处理流程 14.2 总体结构 15 接口设计 15.1 外部接口 15.2 内部接口 16 数据结构设计 16.1 逻辑结构设计 16.2 数据结构与程序的关系 17 使用说明

2、17.1 安装与初始化 17.2 软件主要功能的使用说明 11 引言1.1 软件简要介绍本软件主要用于用户记录自己的时间日志，以便清晰的回顾每天的时间安排，并且支持基本的分析处理和报表功能。其最终目的是提高用户的时间管理技能，从而提高劳动生产率。该软件也是作者第一次开发富客户端软件的技术尝试。1.2 项目背景国内外已有同类型的软件。其功能未知。1.3 项目的创新点未知1.4 定义？2 任务概述2.1 目标？目标和软件简要介绍的区别？2.2 运行环境操作系统：Windows/Linux以及其它支持Java的操作系统数据库：MySQL数据库。（以后版本将支持多种数据库，并考虑软件内置数据库）2.3

3、 应用技术编程语言：Java 1.6数据库：MySQLIDE: Eclipse 3.7AOP：SpringOR Mapping：JPA用户界面：Swing (Windows Builder + Swing)组件管理：Maven数据库建模：？业务建模：？版本控制：sourceforge git3 需求3.1 功能需求3.1.1 用例：用户主界面图 1 用户主界面3.1.2 用例：用户可以即时记录一个活动的开始(v0.1)图 2 记录活动开始3.1.3 用例：用户可以即时记录一个活动的结束(v0.1)图 3记录活动结束3.1.4 用例：用户可以即时记录一个活动的结束和另一个活动的开始(v0.1)合

4、并入3.1.2，待观察3.1.5 用例：用户可以事后记录一个活动的开始(v0.1)参见用例3.1.2和3.1.173.1.6 用例：用户可以事后记录一个活动的结束(v0.1)参见用例3.1.3和3.1.173.1.7 用例：用户可以事后记录一个活动的结束和另一个活动的开始(v0.1)参见用例3.1.2和3.1.173.1.8 用例：用户可以将活动进行分类(v0.1)默认支持以下分类和值：活动类型：编程测试（工作1），需求设计（工作2），管理（工作3），信件，会议，其它工作，学习，休闲，家庭家务，社交，交通，生理，其它，未记录日期类型：节假日，工作日3.1.9 用例：系统安装，并根据JDBC配置

5、自动生成表，加载初始化数据。(v0.1)默认要求用户提供JDBC URL，用户名，密码，Schema。默认使用MySQL的驱动3.1.10 用例：用户可以以表格形式查看一段时间的所有活动(v0.1)在图例部分按照工作日和休息日自动计算每一种活动的百分比。3.1.11 用例：用户可以以柱状图的形式查看一天的所有活动(v0.2)柱状图用不同的颜色标识不同的活动类型可以直接在柱状图上查看活动细节在图例部分自动计算每一类活动的百分比。3.1.12 用例：用户可以以柱状图的形式查看一周的所有活动(v0.2)柱状图用不同的颜色标识不同的活动类型可以直接在柱状图上查看活动细节在图例部分按照工作日和休息日自动

6、计算每一类活动的百分比。3.1.13 用例：用户可以以柱状图的形式查看一段时间的所有活动(v0.3)柱状图用不同的颜色标识不同的活动类型可以在柱状图上通过鼠标停留查看活动细节3.1.14 用例：用户可以以Excel格式输出报告(v0.3)3.1.15 用例：用户将某个工作日改为节假日或将节假日改为工作日。(V0.3)3.1.16 用例：用户可以在日活动图上双击来输入活动 (v0.4)3.1.17 用例：用户可以在日活动图上双击来变更活动 (v0.4)3.1.18 用例：用户可以在日活动图上拖动鼠标来输入活动 (v0.4)3.1.19 用例：用户可以对比两个不同时间段时间分配的差别。(v0.5)

7、可以选择“仅工作日”，“仅节假日”，“全部”三种形式。3.1.20 用例：支持嵌入式数据库(v1.0)3.1.21 用例：支持用户修改活动分类。(v1.0)3.1.22 用例：在Windows平台上支持热键激活(v1.0)3.1.23 用例：用户可以导入导出某个时间阶段的数据(v1.0)3.1.24 用例：用户可以以图表形式查看一段连续期间内某几种活动时间比例的变动情况。(v2.0)3.1.25 用例：用户可以导入导出配置信息(v2.0) 3.1.26 用例：支持国际化(v2.0)3.1.27 用例：用户可以定义工作日和节假日的默认起始时间(V3.0)在本用例实现之前，默认为早8点到晚10点3

8、.1.28 用例：用户可以定制某一天的起始时间(V3.0)3.2 性能需求3.2.1 数据精确度时间精确到分百分比精确到小数点后一位(如10.3%)3.2.2 时间特性要求数据录入小于3秒产生图表和报告一般不超过15秒4 总体设计4.1 基本设计概念和处理流程4.2 业务模型4.3 数据库表结构5 接口设计5.1 外部接口【说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系、用户界面。如无，可省略。】5.2 内部接口【说明本系统之内的各个系统元素之间的接口的安排。】6 数据结构设计6.1 逻辑结构设计【给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录的标识、定义、长度及它们之间的层次的或表格的相互关系。可使用ER图或类图说明。】6.2 数据结构与程序的关系【说明各个数据结构与访问这些数据结构的功能模块的关系。】7 使用说明7.1 安装与初始化【一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。】7.2 软件主要功能的使用说明【对软件主要功能的操作和输入输出做简要的说明】