QR-RD-022(Ver1.2)
Xxx软件
概要设计方案
(内部资料请勿外传)
编写：日期：
检查：日期：
审核：日期：
批准：日期：
XX公司
版权所有不得复制
文档变更记录
目录
1. 引言 (4)
1.1 编写目的和范围 (4)
1.2 术语表 (4)
1.3 参考资料 (4)
2. 需求 (5)
2.1 总体描述 (5)
2.2 功能 (5)
2.3 性能分析 (8)
2.3.1 精度 (8)
2.3.2 时间特性 (8)
2.3.3 灵活性 (9)
2.3.4 可靠性，可维护性，可操作性、防呆性 (9)
3. 环境 (10)
3.1 设备环境 (10)
3.2 软件环境 (10)
3.3 接口 (10)
3.4 保密与安全 (11)
3.4.1 说明 (11)
3.4.2 设计 (11)
3.4.3 数据传输部分 (11)
3.4.4 IP过滤分部 (11)
4. 业务功能设计 (11)
4.1 运行过程 (11)
4.2 逻辑流程 (11)
4.3 功能模块 (13)
4.4 数据流向 (14)
4.4.1 输入 (14)
4.4.2 输出 (15)
4.5 通信协议 (18)
5. 数据库设计 (29)
6. 系统出错处理 (30)
1.引言
1.1 编写目的和范围
说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.2 术语表
定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。
1.3 参考资料
列出有关资料的名称、作者、文件编号或版本等。参考资料包括：
a．需求说明书、架构设计说明书等；
b．本项目的其他已发表的文件；
c．引用文件、资料、软件开发标准等。
2.需求
概述系统的需求，指出有关的变更和增删
2.1 总体描述
包括数据文件名称及其所在目录，功能说明，具体常量说明等。
概括说明和图示系统主要部分之间的内部关系，使本文之外的内容有一个引用的线索，需要整个系统的结构框图（硬件、软件），便于了解整个系统的功能，界面结构，功能模块入数据库、通信等。
本软件作为老炼台的主要操作和信息显示界面，提供设备更好的易用性和功能灵活性，通过对组合老炼的自动化管理控制提高组合的批产效率。
上位机软件与老炼台之间的接口采用422接口，采用私有格式的数据交换通信协议，协议内容主要包括设置和查询两类。
本软件是老炼试验台专用软件，老练完成生成动态的老练报表电子表格文件。
老炼台（包含本软件）的最终用户是所装调部工人，要求操作界面简单易用，流程清晰，相关内容命名统一规范。要求软件具有一定范围的灵活性和适应性，以适用可能发生的用户生产流程改变，软件在一般情况使用时应该不需要特别的维护。
项目对时间进度的要求苛刻，建议在软件架构设计时尽量熟悉老炼试验过程的目的和特点，使得架构具有一定的适应性和灵活性，可以先完成核心架构和基本功能，满足进度要求，后期再进行必要的改进和完善。
2.2 软件功能
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
定性且定量地描述系统总体功能，并说明这些功能是如何满足功能需求的，这里应与软
件需求规格说明中所述的功能相一致，提供功能列表，每个需求分解出能支撑需求的功能列表；
功能描述应包括：
1），数据处理，如何处理
2），界面显示，如何显示
3），通信功能，如何通信
由上位机软件设置门限极限参数包括电压、电流、时间，发送加电、断电指令控制老炼，到达指定次数后完成老炼（自动断电并报告），老炼期间可人工终止。对同时老炼的8套组合可以独立控制，也可以统一操作，方便用户使用。开始老炼后上位机定时向下位机发送查询指令，下位机返回测量数据，在查询指令发送后超出等待返回时间，上位停止所有操作流程终端上位机程序，等待管理人员进行处理。数据为每路电压、电流测量值、老练时间，如果数值连续多次超出范围则判为故障，自动断电并报告故障。由下位机判断电压、电流、老练时间门限值，超出范围断开些路供电并声光报警。同时记录当前出错的数据及相应的状态。可以供上位机查询显示记录。
要求每个通道的相关操作控件和显示信息集中分块显示（分成8行）。
可以通过产品识别号查询并打印完整老炼记录，记录内容包括每一次老炼次数，加电状态，加电时间，软件界面示意图如下
图1 二次电源老炼台主界面
a.软件需要显示8个通道的使能控制，显示加电（绿灯）和故障（红灯）状态，
产品名称，采集的电压值和电流值。
b.对同时老炼的8套组合可以独立控制，也可以统一操作，方便用户使用。用
户可以勾选1~8个通道的复选框以使能该通道，然后向下位机发送通道使能命令。
c.在加电老炼期间，用户可以随时暂停老炼某些通道或全部通道。
d.发现故障后禁止相应的通道，等待用户处理后手动使能。
e.可以通过产品编号查询并打印完整老炼记录。
f.按用户设置的更新时间定时向下位机发送状态查询命令。接收数据后刷新软
件界面。
g.数据能实时保存，避免掉电之后数据丢失。
h.（选加功能）能以图表的方式显示电流电压历史记录，由用户调出观察，便
于直观看出老炼记录。如下图：
图3 电压采集记录
图4 电流采集记录
黄色线条为电压值，绿色线条为电流值，时间轴可调，电压电流显示范围可调，界面类似示波器。
2.3 性能分析
系统工程师需要能给出软件性能可行性分析
2.3.1 精度
必须说明系统数据精度要求：
a)数据的精度要求；
b)数据计算的精度要求；
c)数据传输时的误码率要求。
2.3.2 时间特性
说明系统的时间要求。如：
解题时间要求；
系统响应时间要求；
数据更新处理时间要求；
数据转换（包括数/模、模/数、坐标转换）要求；
数据传输要求。
2.3.3 灵活性
说明程序适应需求变化（包括操作方式、运行环境、与其它的软件接口、精度、有效性和时间特性等变化）的能力，并列出专门为适应这些变化而设计的成份。
2.3.4 可靠性，可维护性，可操作性、防呆性
说明系统可靠性和可维护性要求，那些功能模块需要具备上述功能要求。如：
a)系统的可靠性和可维护性的指标；
b)系统的可靠性和可维护性的设计方案。
故障包括通信故障和监测故障
1.通信故障
包括网络中断和应答错误，如果是通信中断错误，上位机等待一定的时间重新发送命令，监测网络连接，如果重发5次仍然没有反应，则上位机弹出通信中断对话框，提示客户进行处理。
如果是应答错误，（错误码详见附录A）上位机重复发送命令，如果重发5次仍然错误，则上位机弹出通信错误对话框，包括错误类型。提示客户进行处理。
上位机实时的向下位机发送心跳命令，如果发送命令等到一定的时间没有返回或超出发送次数，上位机提示通信故障停止老练。下位机等待接受心跳命令，如果在一定时间没有收到上位机发送的命令，在下位机打开蜂鸣器。表示通信故障提示用户处理。
2.电压异常
判断收到的电压值是否超过设定的范围，如果超过范围，则禁止全部（兼容一个电源带几个设备的情况）通道，发送电压报警命令，并在下位机声光报警。在上位机用户界面提示过压或欠压错误，等待用户处理完成后继续老炼。
3.电流异常
判断收到的电流值是否超过设定的范围，如果超过范围，则禁止相应通道，发送电流报警命令，并在下位机声光报警。在上位机用户界面提示过流错误，等待用户处理完成后继续老炼。
3.环境
3.1 设备环境
列出系统所需的设备，包括目前可用设备。并详细论述准备配置的新设备的特性，如处理器数目、内存容量、外存介质种类和数目、输入输出设备类型和数目、数据传输介质和传输速度等。
3.2 软件环境
列出与系统互相配合的支持软件和测试软件，即所使用的编程语言、编译程序、汇编程序、操作系统或监控程序等。若系统的运行可能与这些支持软件的变化有关时，则应指出这些变化的性质、状态和预定日期等。
本软件运行在CPCI工控机上，操作系统为Windows XP或后续升级版本，无其它特殊要求和接口。
3.3 接口
具体说明系统同硬件和其它软件之间的接口关系，包括：
a)接口种类。例如是操作员控制的端点，或是其它程序接口；
b)数据传输操作说明（协议）
c)系统输入、输出数据的传送要求，包括数据内容、顺序、时间性和容量等以及传送用的通信介质的特性；
d)接口的格式、度量单位、值域和数据编码，数据交换中使用的缩写词等；
e)接口的规程。
3.4 保密与安全
说明系统及其成份的可用性、完整性和保密性、在各层次的保护等级，并讨论各部分的相互关系、相互影响的执行顺序。
3.4.1 说明
例如：由于存在与外部系统的接口,所以需要考虑访问安全的问题.
3.4.2 设计
例如：分为数据传输部分,IP过滤部分,身份验证部分.[章节可补充]
3.4.3 数据传输部分
例如：在部分数据传递的时候,考虑以https协议,需要在部署的时候作相关处理.
3.4.4 IP过滤
例如：可在系统前端通过Filter实现,该Filter实现对该地址访问的IP过滤作用.可信任IP地址通过xml文件进行配置.
4.业务功能设计
4.1 运行过程
对系统装入、启动、恢复、再启动和停止等作一般性说明，软件编译后的可执行文件需要包括工具软件、仪器驱动等；或者在软件使用说明书中作详细描述。
4.2 逻辑流程
以图表的形式描述系统逻辑流程。各图表集中表示系统的动态特性、入口、出口和与其它程序的接口，同时对各种运行、优先级、循环和特殊处理加叙述。总之，应表示出从输入开始，经过系统处理，到输出的整个流程。
老炼台的总的测试流程如图2所示：
图6 测试流程图
测试流程如下：
a.打开程序首先判断日志文件有无上次老炼记录，上次老炼是否完成，
如果上次老炼没有完成，提示客户是否继续上次老炼。
b.如果没有老炼记录，或者上次老炼完成，提示客户是否修改默认参
数，然后初始化参数，包括极限参数，报警参数，工作参数（加电
和休息时间，加电次数）。
c.输入产品编号，作为产品的识别号，据此可以查询该产品的老炼状
态及故障情况等。
d.开始老炼，定时发送状态查询命令，检测电压电流。
e.判断是否有通信异常，包括收到错误的应答或收不到应答，如果有
错误重新发送命令，如果多次错误就暂停操作，在用户界面提示通
信错误及错误类型，等待用户处理完后继续老炼。
f.判断收到的电流值是否超过设定的范围，如果超过范围，则禁止相
应通道，发送电流报警命令，在用户界面提示过流或电流过低错误，等待用户处理完成后继续老炼。
g.判断收到的电压值是否超过设定的范围，如果超过范围，则禁止全
部通道，发送电压报警命令，在用户界面提示过压或欠压错误，等
待用户处理完成后继续老炼。
h.暂停和重新启动老炼过程，是考虑到在老炼全过程中，试验人员随
时会终止老炼试验的可能。暂停时，需保存当前条件设置和老炼记
录供下次重启时调用，完成后续老炼工作。
i.在老炼过程中需要实时保存老炼数据及记录，包括正常数据和出现
的错误。
j.达到单次时间后自动停止加电，记录此次加电是否正常，等休息时间结束后继续加电老炼。
k.在没有发生电压、电流不正常的情况下，达到老炼的次数后，自动停止加电，并生成试验记录，老炼过程结束。
l.故障产品移除后，用户可以继续加电老炼其余产品，直至老炼试验结束。故障产品修复后，再重新进行老炼试验。
4.3 功能模块
4.4 数据流向
对系统的输入和输出加以描述。调用方式
4.4.1 输入
包括对输入数据记录和每个数据元素的描述。应对每个数据项描述如下内容。
正常工作时软件按照客户填的加电时间和休息时间参数进行老练，到达设置时间后上位机需要向下位机发送加电/断电设置，在加电过程中，实时发送状态查询命令，监测收到的电压电流值是否超出范围，并显示。如果超出范围，进行故障处理。
表2老炼台工作参数表
在老炼过程中可能存在用户暂停的情况，需要进行相应处理。为防止出现突然的软件故障（如关闭软件，死机，断电），需要实时保存数据和老炼记录，并设置好正常工作标志，在下次打开软件后读取相应记录及标志就可以继续老炼。
如：在老练期间出现故障，此次老练记录作废。
表3老炼台报警参数表
注：（1）n为用户设置的加电次数，每个产品一个表格
4.4.1.1 输入数据存储
记录标题和标识符；
信息源、介质和介质配置；
预估容量和频率；
优先级，例如可分为一般作业和紧急情况等级别；
敏感程度；
时间要求。
4.4.1.2 输入数据元素及形式
需要包括输入数据的形式，入表格输入，数据库输入，界面输入，那些输入需要体现在用户界面上。
名称和标识符；
在数据记录中的位置；
同义名；
定义；
度量单位；
格式和值域；
敏感程度；
数据项名、缩写词和代码以及输入时使用说明。
4.4.2 输出
对每个输出的数据应描述如下内容。
在设定的加电老炼完成后，自动断电并生成试验记录表格，表格形式见表4
表4老炼试验记录
产品名称：产品代号：产品批次：产品编号：
接收到的采集数据后需要以日志的形式记录下来，当超过用户设置的报警参数时，需要切断该通道电源，发送报警命令，点亮故障指示灯，提示客户，并将报警信息记录到日志里。日志以Excel的格式保存。
i.以图表的方式显示电流电压历史记录，由用户调出观察，便于直观看出老炼
记录。如下图：
图3 电压采集记录
图4 电流采集记录
黄色线条为电压值，绿色线条为电流值，时间轴可调，电压电流显示范围可调，界面类似示波器。
4.4.2.1 输出报告
标题和标识符；
格式。包括标题名、行间隔、排列位置或方式等；
显示工具。如显示器、打印机、监示器和指示灯等；
预估其容量和频率；
优先级别。如一般作业、紧急情况等级别；
时间要求。如响应时间、传输时间和处理时间等；
敏感程度。
4.4.2.2 输出数据元素
名称和标识符；
同义名；
定义；
度量单位；
格式和值域；
敏感程度；
数据项名、缩写词和代码以及输出时使用的规格说明。
4.5 通信协议
上位机和下位机采用422全双工应答通信方式，上位机发送命令，下位机应答并返回数据，详细协议见《附录A老炼台422通信协议》。
帧格式
协议说明
通讯协议是问答模式，上位机发送指令，下位机应答；下位机发送指令上位机应答。
通讯协议中命令字，发送和应答是一样的。
通讯协议数据内容不定长，接受数据包数据长度或校验和与协议不符，表示数据包错误。或可以判断帧尾来判断数据包结束。
每个命令都有命令计数，初始化为0, 发完命令后加1，当发完复位命令后计数值清0；下位机如果接收校验和正确会返回命令序号（返回的命令序号由下位机计数）,以便做对比,防止漏收命令。命令序号计满65535后清0
地址码为多机通信时用，如果是点对点通信地址为0。0xff为广播，广播不回复(根据项目需求而定)。
如果命令不带返回数据，数据长度为0，没有数据部分。
数据包内容字段根据不同的命令字来解析内容字段数据。
每条命令都需要有应答码，在发起端默认为0。再应答端返回0表示命令成功，如果应答码为1表示命令失败。可以根据答应码表来进行相应的处理。
在内容字段内的数据值都是有符号表示的。如2Byte 范围-32768~32767；
二、应答码
三、命令字
根据具体项目定制命令字，可以按命令字区分类别。
命令字0~20为执行命令；
20~40为设置配置数据；
40~60查询命令；
三、内容格式说明
以下格式说明中的起始位置都是基于数据内容本身，不影响原帧格式。对于多字节的数值，高位在前。
数据中的校验和为整个帧数据（除去帧头帧尾）的累加和的低8位。0x01、设备复位
软件详细设计说明书 v1.0 200X年月XX日 修订历史记录
编制 审查 审核 批准 文档评审负责人：参加评审人员：
目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4设计依据 (4) 2软件系统结构 (4) 2.1功能需求 (4) 2.2子模块划分 (4) 2.3子模块间关系 (4) 3公共数据结构 (4) 4程序设计说明 (5) 4.1程序1设计说明 (5) 4.1.1程序描述 (5) 4.1.2功能 (5) 4.1.3性能 (5) 4.1.4输入 (5) 4.1.5输出 (5) 4.1.6算法 (5) 4.1.7流程 (5) 4.2程序2设计说明 (5) 5模块重用说明 (5)
1引言 1.1编写目的 〖说明编写这份软件详细设计说明书的目的〗 1.2背景 〖说明待开发软件（子）系统的名称和此软件（子）系统所属大系统的名称； 说明任务的来源（开发背景和市场背景）等；该软件（子）系统与大系统中其他子系统的关系。〗 1.3定义 〖列出本文档中所用到的专门术语的定义和缩写词的原意〗 1.4设计依据 〖列出本文档所引用的有关设计依据（标题、文件编号、版本号、作者、发布日期、出版单位），包括本项目内部已编写的有效文档、出版刊物和国家标准或规范〗2软件系统结构 2.1功能需求 2.2子模块划分 〖说明本软件系统(或模块)的实现，即其内部的子模块划分（给出程序的名称和标识符）。建议以图形说明。〗 1.XXXXXXXX 2.XXXXXXXX 3.XXXXXXXX 4.XXXXXXXX 5.XXXXXXXX 6.XXXXXXXX 2.3子模块间关系 〖说明各子模块间的控制、顺序等耦合关系。〗 3公共数据结构 〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似Ｃ语言的数据说明格式来描述。〗
软件详细设计报告文档 Document serial number【UU89WT-UU98YT-UU8CB-UUUT-UUT108】
软件详细设计报告文档模板 1. 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。
如果这份软件系统详细设计报告只与整个系统的某一部分有关系，那么只定义软件系统详细设计报告中说明的那个部分或子系统。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： ●任务提出者； ●软件开发者； ●产品使用者。 1.3 文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。编写约定应该包括： ●部件编号方式； ●界面编号方式； ●命名规范： ●等等。 1.4 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，例如，可能的读者包括： ●开发人员； ●项目经理；
●测试人员； ●文档编写人员； ●等等。 描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 1.5 参考资料 列举编写软件系统详细设计报告时所用到的参考文献及资料，可能包括： ●本项目的合同书； ●上级机关有关本项目的批文； ●本项目已经批准的计划任务书； ●用户界面风格指导； ●开发本项目时所要用到的标难； ●系统规格需求说明； ●使用实例文档； ●属于本项目的其它己发表文件； ●本软件系统详细设计报告中所引用的文件、资料； ●相关软件系统详细设计报告； ●等等。 为了方便读者查阅，所有参考资料应该按一定顺序排列。如果可能，每份资料都应该给出： ●标题名称； ●作者或者合同签约者；
QR-RD-022(Ver1.2) Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期： 检查：日期： 审核：日期： 批准：日期： XX公司 版权所有不得复制
文档变更记录
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (5) 2.1 常量 (6) 2.2 变量 (6) 2.3 数据结构 (6) 3. 模块设计 (6) 3.1 用例图 (6) 3.2 功能设计说明 (6) 3.2.1 模块1 (6) 3.2.2 模块2 (7) 4. 接口设计 (8) 4.1 内部接口 (8) 4.2 外部接口 (8) 4.2.1 接口说明 (8) 4.2.2 调用方式 (8) 5. 数据库设计 (8) 6. 系统安全保密设计 (9) 6.1 说明 (9) 6.2 设计 (9) 6.2.1 数据传输部分 (9) 6.2.2 IP过滤分部 (9) 6.2.3 身份验证部分 (9) 7. 系统性能设计 (9) 8. 系统出错处理 (9)
1.1编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.2术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 1.3参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； 1.4使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio] 2.全局数据结构说明 本章说明本程序系统中使用的全局数据常量、变量和数据结构。
计算机学院实验中心----Android手机客户端 学生姓名：宋同煜张宗森 指导老师：裴斐 专业：计算机科学与技术102
在移动互联网发展迅猛的今天，在Android完全开源及拥有庞大用户群的环境下，迫切需要为计算机学院实验中心网站开发Andriod手机客户端，方便计算机学院师生随时随地查看实验信息、登记实验等。 。 一、系统分析 需求分析 查询实验：教师及学生可以查询当周及上一周、下一周实验安排 登记实验：教师登录后可以登记实验 引言 为方便计算机学院教师及学生查询、登记实验，因此开发实验中心Android手机端软件 编写目的 本文档对计算机学院实验中心网站手机客户端的功能、用户界面、运行环境等作出详细说明。 项目背景 软件的开发名称：计算机学院实验中心 项目需求单位：计算机学院全体师生 项目开发单位：宋同煜张宗森 二、系统设计 系统目标 1.实现需求分析阶段的所有功能 2.主界面清晰、简单、操作易行 系统功能预览
该软件主要包括查询、登录、登记实验3个功能模块，主要操作如下： （1）运行软件后，首先检查网络连接是否正常，如果正常，获取当周实验安排信息，显示给用户，效果如图 （2）通过“菜单->登记实验”进入等级实验页面，要求输入用户名密码才可继续
点击“登录实验”后，提示登录后才能继续 （3）点击登录进入登录页面，如图 正确输入用户名密码后点提交 （4）用户名密码输入正确，就可以登记实验了，次页面包含实验名、课程名、班级、机房、
第几大节、实验日期等信息的填写，如图 （5）正确填写实验信息后，确认登记后点提交，返回登记结果
XXX软件/项目/系统 详细设计说明书 拟制日期 评审人日期 批准日期 编写单位或个人
修订历史
目录 XXX软件详细设计说明书 (1) Revision Record 修订记录 (2) 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3参考资料 (1) 1.4术语定义及说明 (1) 2设计概述 (1) 2.1任务和目标 (1) 2.1.1需求概述 (1) 2.1.2运行环境概述 (1) 2.1.3条件与限制 (1) 2.1.4详细设计方法和工具 (1) 3系统详细需求分析 (1) 3.1详细需求分析 (2) 3.2详细系统运行环境及限制条件分析接口需求分析 (2) 4总体方案确认 (2) 4.1系统总体结构确认 (2) 4.2系统详细界面划分 (2) 4.2.1应用系统与支撑系统的详细界面划分 (2) 4.2.2系统内部详细界面划分 (2) 5系统详细设计 (2) 5.1系统结构设计及子系统划分 (3) 5.2系统功能模块详细设计 (3) 5.3系统界面详细设计 (3) 5.3.1外部界面设计 (3) 5.3.2内部界面设计 (3) 5.3.3用户界面设计 (3) 6、数据库系统设计 (4) 6.1设计要求 (4) 6.2 信息模型设计 (4) 6.3数据库设计 (4) 6.3.1设计依据 (4) 6.3.2数据库种类及特点 (4) 6.3.3数据库逻辑结构 (4) 6.3.4物理结构设计 (4) 6.3.5数据库安全 (4) 6.3.6数据字典 (4) 7非功能性设计 (4) 8 (5) 9环境配置 (5)
1引言 1.1编写目的 说明编制的目的是，大体上介绍一下软件系统中各层次中模块或子程序、以及数据库系统的设计考虑，表明此文档是主要是为编码人员提供服务，并且其他类型的项目参与人员也可以通过此文档对软件/项目有更深入了解。 1.2背景 说明此软件或系统的项目背景、需求背景、开发目的等，还可以列出参与人员等相关信息。 1.3参考资料 列出本文档中引用的文献、资料、标准等相关信息（一般是具有出版或版权性质的文件）。 1.4术语定义及说明 列出文档中用到的和开发有关，或与行业、业务、需求有关的专业术语，并进行解释。 2设计概述 2.1任务和目标 说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 2.1.2运行环境概述 对本系统所依赖于运行的硬件，包括操作系统、数据库系统、运行库、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 2.1.3条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具，如数据库设计工具、界面设计工具、原型设计工具等。 3系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
目录
(9) 5
1. 范围 本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软件项目承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可根据实际情况采编写，但必须提供双方约定的文档，文档中约定的内容必须描述清楚。 2. 总体要求 2.1 总体功能要求 网络应用环境以Internet/Intranet技术为核心。 开发者应在充分分析需求的基础上，选择采用B/S结构或者C/S结构。 软件系统的数据库应依照《南京市交通局信息化数据库建设规范》进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体特点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议开发商使用面向对象软件工程的方法，如：采用目前被广泛使用的RUP(Rational Unified Process)方法来进行分析、设计和开发。
2.2 软件开发平台要求 开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。目前软件平台为： 数据库管理系统： Oracle 9i以上版本 中间件(应用服务器)系统： IBM WebSphere OA系统： Lotus Domino/Notes 网络架构： 完全支持TCP/IP协议 开发工具或技术体系： 为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开发，如Microsoft Visual ，Borland Delphi，C++ Builder, 或J2EE(Java2 P1atform Enterprise Edition)等。 2.3 软件项目的开发实施过程管理要求 2.3.1 软件项目实施过程总体要求 （一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提出整改意见。 （二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设
. Xxx系统详细设计说明书 ) 请勿外传(内部资料 编日写：期： 期：查：检日 期：核：审日 日期：准：批 XX公司 不得复制版权所有 精选范本 . 文档变更记录
精选范本 . 目录 1. 引言.............................................................................................................................................................. .. (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5)
1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量.............................................................................................................................................................. (7) 2.2 变量.............................................................................................................................................................. (8) 2.3 数据结构 (8) 3. 模块设计.............................................................................................................................................................. .. (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块 1 (10) 3.2.2 模块 2 (11) 4. 接口设计.............................................................................................................................................................. (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计.............................................................................................................................................................. .. 13 6. 系统安全保密设计 (13) 6.1 说明.............................................................................................................................................................. . (13) 6.2 设
实用文案
修订记录
目录 第一章概述 (5) 1.1.应用模块的目的 (5) 1.2.应用模块总体描述 (5) 1.3.应用模块接口描述 (5) 1.4.假设条件 (5) 第二章设计模式（Design pattern） (6) 第三章类设计 (7) 3.1.分块类图 (8) 3.1.1.<类图1> 8 3.1.2.<类图n> 8 3.2.整体继承关系 (8) 3.3.类描述 (9) 3.3.1.<类名1> Class Description 9 3.3.2.<类名n> Class Description 10 第四章交互图 (12) 4.1.<情景编号1: 情景名称> (12) 4.1.1.交互图 12 4.1.2.例外情况及条件 13 4.2.<情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1.<状态图编号1:状态图名称> (14)
5.2.<状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1.用户界面关系 (18) 7.2.用户界面具体描述 (18) 7.2.1.<界面编号1:界面名称〉 18 7.2.2.<界面编号N:界面名称〉 19 第八章测试考虑 (20) 第九章附录 (21) 9.1.附录A 代码举例 (21) 9.2.附录B 设计问题 (21) 9.2.1.<设计问题1> 21 9.2.2.<设计问题n> 21
第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。包括系统的约束条件和应遵循的标准。
软件详细设计报告文档 1. 引言 随着近些年来社会和科技的发展，越来越多的人使用电子设备查询各种信息，最常见的一个查询软件就是——电子词典，其主要的市场目标是学习外语的人群。从软件功能来看，英文电子词典一直高居榜首，虽说学习第二语言可以帮助我们更加方便的与全球进行交流的，但是作为一名炎黄子孙，中国上下五千年的文化渊远流长，因此我们此次项目所实施的功能是成语查询，该软件可以帮助人们随时随地更加方便地查询成语的意思以及用法，使其使用者可以更加深入的了解中国成语文化，使汉语文化可以发扬光大。 1.1 编写目的 本详细设计的编写目的在于描述成语词典的界面设计、查询功能、数据库收集与导入等。在简要描述视成语词典的整体环境搭建的基础上，详细说明查询模块，为以后的开发工作提供可靠的依据。 1.2 预期读者和阅读建议 本软件产品所针对的的预期读者，包括： ●用户； ●开发人员； ●测试人员； ●文档编写人员。 1.3 参考资料 编写此详细设计时所用到的参考文献及资料，包括： 2. 设计概述 2.1 限制和约束 起到限制和约束作用的各种可能存在的条件： ●技术条件； ●开发环境； ●时间限制；
●数据库内资源的多少。 实现的系统目标：在成语查询的首页有成语推荐，若要查询成语，输入其关键字或整体，点击“查询”按钮，系统进行自动查询，如果有任何意见或者建议，可以点击“我要留言”，进行反馈。 2.2 系统组织设计 通过系统组织表描述搜索系统由下列子系统组成，这些子系统与业务职能之间的关系。系统组织表如下： 子系统编号中文名称业务职能备注 1 环境搭建、界 面设计以及 查询模块 在UNIX下，基于php+apache+mysql的 环境下，进行界面和查询模块的开发， 包括查询结果的显示。 周婷婷 2 数据库模块收集成语的释意以及用法，加上post或 get内容的特殊符号处理，将其导入到数 据库中。 李燕 3 数据库模块收集成语的释意以及用法，将其导入到 数据库中，并加上分页函数类和首页成 语推荐。 宋彧婕 2.3 系统结构设计 2.3.1 整体结构 爬虫 索引 查询
项目编号： （项目名称） 软件详细设计报告文件编号：生效日期：年月日 编制：日期：审核： 日期： 批准： 日期：同方锐安科技有限公司
目录 1. 引言 (1) 1.1编写目的 (1) 1.2项目风险 (1) 1.3文档约定 (1) 1.4预期读者和阅读建议 (1) 1.5参考资料 (2) 2. 支撑环境 (2) 2.1数据库管理系统 (2) 2.2开发工具、中间件以及数据库接口 (2) 2.3硬件环境 (2) 2.4网络环境 (3) 2.5多种支撑环境开发要点 (3) 3. 部件详细设计 (4) 4. 词汇表 (5) 5. 部件表格式 (5) 6. 界面表格式 (6)
1. 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： ●任务提出者； ●软件开发者； ●产品使用者。 1.3 文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。 编写约定包括： ●部件编号方式； ●界面编号方式； ●命名规范： ● 1.4 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 读者包括： ●开发人员； ●项目经理； ●测试人员； ●文档编写人员； ●
需求名称Array— （ [ XXX项目小组
修订表
审批记录 目录 1.引言.............................................................. 错误!未定义书签。 目的............................................................... 错误!未定义书签。 ` 范围............................................................... 错误!未定义书签。 读者对象........................................................... 错误!未定义书签。 参考资料........................................................... 错误!未定义书签。 术语与缩略语....................................................... 错误!未定义书签。 2.设计概述.......................................................... 错误!未定义书签。 任务和目标......................................................... 错误!未定义书签。 3.系统详细需求分析.................................................. 错误!未定义书签。 详细需求分析....................................................... 错误!未定义书签。 # 详细系统运行环境及限制条件分析接口需求分析 ......................... 错误!未定义书签。 4.总体方案确认...................................................... 错误!未定义书签。 系统总体结构确认................................................... 错误!未定义书签。 系统详细界面划分................................................... 错误!未定义书签。 应用系统与支撑系统的详细界面划分 ....................... 错误!未定义书签。 系统内部详细界面划分 ................................... 错误!未定义书签。 5.系统详细设计...................................................... 错误!未定义书签。 系统结构设计及子系统划分 ........................................... 错误!未定义书签。 ? 系统功能模块详细设计..................................................... 错误!未定义书签。 系统界面详细设计 ......................................................... 错误!未定义书签。 外部界面设计................................................... 错误!未定义书签。 内部界面设计................................................... 错误!未定义书签。
编号：_________________ 版本：_________________ <系统名称> 详细设计说明书 委托单位: 承办单位: 编写:(签名)_________________年月日 复查:(签名)_________________年月日 批准:(签名)_________________ 年月日
目录 第1章引言 (1) 1.1编写目的 (1) 1.2系统说明 (1) 1.3术语 (1) 1.4参考资料 (1) 第2章软件结构 (2) 2.1软件结构图 (2) 2.2模块子结构图 (2) 2.3模块清单 (2) 第3章模块设计 (3) 3.1模块1 （标识符） (3) 3.1.1模块概述 (3) 3.1.2功能和性能（1、功能 2、性能） (3) 3.1.2.1（标识符）功能（ＩＰＯ图） (3) 3.1.2.2性能 (3) 3.1.3输入/输出项 (3) 3.1.3.1输入项 (3) 3.1.3.2输出项 (3) 3.1.4数据结构 (3) 3.1.4.1全局数据结构 (4) 3.1.4.2局部数据结构 (4) 3.1.5算法 (4) 3.1.6限制条件 (4) 3.1.7测试计划 (4) 3.2模块2 (4)
第1章引言 1.1编写目的 软件详细设计说明书的一般编写目的可直接引用下面一段话：“说明一个软件系统各个层次中的每个程序（每个模块或子程序）的设计考虑。”当然，作者可包含一些与问题相关的特殊目的，附于上述一段话的尾部 1.2系统说明 任务提出单位： 开发单位： 预期用户： 1.3术语 序号术语说明性定义 ＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿ 1.4参考资料 1
软件开发文档模板库 最近设计开发文档的编写，网上查找的时候感觉很不便捷，现整摘要出软件开发过程中的一些文档模板，希望能给朋友们提供便捷的查找，方便大家的使用。 1可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1引言 1.1.1编写目的 1.1.2背景 1.1.3定义 1.1.4参考资料 1.2可行性研究的前提 1.2.1要求 1.2.2目标 1.2.3条件、假定和限制 1.2.4进行可行性研究的方法 1.2.5评价尺度 1.3对现有系统的分析 1.3.1数据流程和处理流程 1.3.2工作负荷 1.3.3费用开支 1.3.4人员 1.3.5设备 1.3.6局限性 1.4所建议的系统 1.4.1对所建议系统的说明 1.4.2数据流程各处理流程 1.4.3改进之处 1.4.4影响 1.4.4.1对象设备的影响 1.4.4.2对软件的影响 1.4.4.3对用户单位机构的影响 1.4.4.4对系统动行的影响 1.4.4.5对开发的影响 1.4.4.6对地点和设施的影响 1.4.4.7对经费开支的影响
1.4.5局限性 1.4.6技术条件方面的可行性 1.5可选择其他系统方案 1.5.1可选择的系统方案1 1.5.2可选择的系统方案2 …… 1.6投资及收益分析 1.6.1支出 1.6.1.1基本建设投资 1.6.1.2其他一次性支出 1.6.1.3非一次性支出 1.6.2收益 1.6. 2.1一次性收益 1.6. 2.2非一次性收益 1.6. 2.3不可定量的收益 1.6.3收益/投资比 1.6.4投资回收周期 1.6.5敏感性分析 1.7社会条件方面的可行性 1.7.1法律方面的可行性 1.7.2使用方面的可行性 1.8结论 2项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1引言 2.1.1编写目的 2.1.2背景 2.1.3定义 2.1.4参考资料 2.2项目概述 2.2.1工作内容 2.2.2主要参加人员 2.2.3产品及成果 2.2. 3.1程序
软件详细设计报告文档模板 1.引言 1.1编写目的 说明编写详细设计方案的主要目的。 说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。 如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设il?说明书中不重复部分合并编写。 方案重点是模块的执行流程和数据库系统详细设计的描述。 1.2背景 应包含以下几个方而的容： A.待开发软件系统爼称： B.该系统基本概念，如该系统的类型、从属地位等； C.开发项目组轻称。 1.3參考资料 列出详细设讣报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。 1.4术语定义及说明 列岀本文档中用到的可能会引起混淆的专门术语、左义和缩写词的原文。 2.设计概述 2.1任务和目标 说明详细设计的任务及详细设汁所要达到的目标。 1丄1需求概述
对所开发软件的槪要描述，包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 1.1.2运行环境概述 对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 1」.3条件与限制 详细描述系统所受的部和外部条件的约束和限制说明。包括业务和技术方而的条件与限制以及进度、管理等方而的限制。 1.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF(I2DEF)方法、E-R图，数据流程图、业务流程图、选用的CASE I具等，尽量采用标准规和辅助工具。 3.系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。 3.1详细需求分析 包括： ?详细功能需求分析 ?详细性能需求分析 ?详细资源需求分析 ?详细系统运行环境及限制条件分析 3.2详细系统运行环境及限制条件分析接口需求分析 包括： ?系统接口需求分析 ?现有硬、软件资源接口需求分析 ?引进硬、软件资源接口需求分析
Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
目录 1. 引言 (4) 1.1 编写目的和范围 (4) 1.2 术语表 (4) 1.3 参考资料 (4) 1.4 使用的文字处理和绘图工具 (4) 2. 全局数据结构说明 (5) 2.1 常量 (5) 2.2 变量 (5) 2.3 数据结构 (5) 3. 模块设计 (5) 3.1 用例图 (5) 3.2 功能设计说明 (5) 3.2.1 模块1 (5) 3.2.2 模块2 (6) 4. 接口设计 (7) 4.1 内部接口 (7) 4.2 外部接口 (7) 4.2.1 接口说明 (7) 4.2.2 调用方式 (8) 5. 数据库设计 (8) 6. 系统安全保密设计 (8) 6.1 说明 (8) 6.2 设计 (8) 6.2.1 数据传输部分 (8) 6.2.2 IP过滤分部 (8) 6.2.3 身份验证部分 (8) 7. 系统性能设计 (9) 8. 系统出错处理 (9)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
软件详细设计报告文档模板 1. 引言 (2) 1.1编写目的 (2) 1.2项目风险 (2) 1.3文档约定 (2) 1.4预期读者和阅读建议 (3) 1.5参考资料 (3) 2. 支撑环境 (4) 2.1数据库管理系统 (4) 2.2开发工具、中间件以及数据库接口 (5) 2.3硬件环境 (6) 2.4网络环境 (6) 2.5多种支撑环境开发要点 (7) 3. 部件详细设计 (7) 4. 词汇表 (9) 5. 部件表格式 (9) 6. 界面表格式 (10)
1. 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。 如果这份软件系统详细设计报告只与整个系统的某一部分有关系，那么只定义软件系统详细设计报告中说明的那个部分或子系统。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： ●任务提出者； ●软件开发者； ●产品使用者。 1.3 文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。编写约定应该包括： ●部件编号方式； ●界面编号方式； ●命名规范： ●等等。
1.4 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，例如，可能的读者包括： ●开发人员； ●项目经理； ●测试人员； ●文档编写人员； ●等等。 描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 1.5 参考资料 列举编写软件系统详细设计报告时所用到的参考文献及资料，可能包括： ●本项目的合同书； ●上级机关有关本项目的批文； ●本项目已经批准的计划任务书； ●用户界面风格指导； ●开发本项目时所要用到的标难； ●系统规格需求说明； ●使用实例文档； ●属于本项目的其它己发表文件； ●本软件系统详细设计报告中所引用的文件、资料； ●相关软件系统详细设计报告； ●等等。 为了方便读者查阅，所有参考资料应该按一定顺序排列。如果可能，每份资料都应该给出： ●标题名称；
系统软件详细设计说明书 1.引言 1.1编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。 2. 系统的结构 ●ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用， 并含有站搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp容列表及其他需要通过xml文件保存的信息。 ●client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的资源， 并返回相应的信息。
●search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方 式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。 ●preview：资源预览部分，显示用户选择的资源的部分容，以使用户决定是否需要该资 源。preview部分调用common部分读取属性文件的容亦显示预览资源容的显示格式。3．模块1（ui）设计说明 3.1模块描述 实现用户界面的包，含有11个文件51个类，是本系统中最复杂的代码。 3.2功能 负责接受用户输入，显示系统输出，其他模块功能的协调调用，并含有站搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。 3.3交互的模块 client，search，preview，common。 3.4 模块设计 该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下： ●MainFrame.java：MainFrame是含有主函数的类，也是lyra客户端开始执行的类， 它先后进行资源的初始化，显示主界面等工作，根据屏幕大小设置界面大小，设置界面的观感。 ●FtpFrame_AboutBox.java:显示关于窗口的类，当用户点击帮助菜单中的关于菜单 项时会弹出关于对话框。 ●Tools.java：FileTools是文件操作辅助类，可以实现文件的递归删除等。 ●XMLController.java: JDOMTes是操作xml文件的类，用JDOM来操作xml文件， 实现的功能有： （1）保存ftp服务器的文件列表（站搜索时使用），递归的从ftp服务器读取列表，并存入一个xml文件中（文件的命名方法是：ip+用户名.xml）;以目录树的形式保存。 （2）根据文件名在文件中查找文件，站搜索时使用。 （3）保存ftp服务器的信息：ip，端口（默认端口21不保存），用户名（默认anonymous 不保存），密码，最多存10个；存在resource\settings\ serversinfor.xml文件中。 （4）读取已存储的ftp服务器信息。 （5）从type.xml读取搜索的类型。 ●Constants.java:放置系统运行时使用的一些常量，initcontent（）函数对所有常量进 行初始化，这个函数在MainFrame中被调用一次。iconHashMap是hash表，用于存放文件的系统图标。 ●CustomizedController.java：包含自定义的控件类，java中的控件可能不能满足需求， 需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有： （1）CustomizedJTable 是表格类，设置表格的某些属性，如字体等。 （2）CustomizedTableCellRenderer是表格单元格绘制器类，主要用于显示文件的系统图标，和文件名。 （3）LeftPanel类的父类是JTabbedPane，用户显示主窗口左边的面板。 （4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务器选项，和中间的显示服务器文件的TabbedPane。. （5）BottomPanel类是右下放显示下载和服务器信息的JTabbedPane。