软件项目详细设计文档模板

研发生产中心文档编号版本A1密级商密A项目名称Xx系统项目来源QR-RD-022(Ver1.2)XXX系统详细设计说明书(内部资料请勿外传)编写：日期：检查：日期：审核：日期：批准：日期：XX公司版权所有不得复制文档变更记录序号变更（+/-）说明作者版本号日期批准12目录1.引言...................................................................................................................................51.1编写目的和范围.....................................................................................................51.2术语表.....................................................................................................................51.3参考资料.................................................................................................................51.4使用的文字处理和绘图工具.................................................................................52.全局数据结构说明...........................................................................................................62.1常量.........................................................................................................................62.2变量.........................................................................................................................62.3数据结构.................................................................................................................63.模块设计...........................................................................................................................63.1用例图.....................................................................................................................63.2功能设计说明.........................................................................................................73.2.1模块1............................................................................错误!未定义书签。3.2.2模块2............................................................................错误!未定义书签。4.接口设计.........................................................................................................................424.1内部接口...............................................................................................................424.2外部接口...............................................................................................................424.2.1接口说明....................................................................................................424.2.2调用方式....................................................................................................425.数据库设计.....................................................................................................................426.系统安全保密设计.........................................................................................................426.1说明.......................................................................................................................426.2设计.......................................................................................................................426.2.1数据传输部分............................................................................................426.2.2IP过滤分部................................................................................................436.2.3身份验证部分............................................................................................437.系统性能设计.................................................................................................................438.系统出错处理.................................................................................................................431.引言1.1编写目的和范围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。1.2术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。序号术语或缩略语说明性定义1PMProjectManager,项目经理21.3参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括：a．需求说明书、架构设计说明书等；b．本项目的其他已发表的文件；c．引用文件、资料、软件开发标准等。资料名称作者文件编号、版本资料存放地点1.4使用的文字处理和绘图工具文字处理软件：wordoffice绘图工具：Visio2.全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1常量staticStringSERVER_ADDRESS服务器地址booleanloginFlag登录状态2.2变量BlueUserInfo用户账户结构体2.3数据结构包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。3.模块设计3.1用例图登录设置人员管理池塘管理育苗管理物流管理注销加工包装数据管理人事部育苗场生产部加工厂市场部系统用户3.2功能设计说明3.2.1登录模块模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。3.2.1.1设计图3.2.1.2功能描述此模块的主要功能是登录验证功能，保证程序的安全性问题。用户需要验证用户和密码是否正确才能进行下一部操作。3.2.1.3输入数据变量名类型说明userNameString用户名(必填)passwordString密码(必填)STOPSPLASHint开场动画标志位SPLASHTIMElong消息发送延迟时间LOGINBUTTONint登录按钮是否能够点击标志位3.2.1.4输出数据字段说明code结果，0表示失败，1表示成功，2表示该养殖场地不存在，3表示该Rfid已存在userName用户名PassWord密码userRoleld用户权限，1代表系统用户，2代表人事部，3代表育苗场，4代表生产部，5代表加工厂，6代表市场部，7代表捕捞管理员表现形式为：code=13.2.1.5流程图登录输入用户名和密码用户名/密码是否为空?用户名是否正确?提示：账号或密码不能为空N提示：用户名不存在YNY用户名是否正确?提示：用户名不存在NY登入系统结束3.2.1.6源程序文件说明3.2.1.7函数说明对密码进行MD5加密：md5(密码)将用户的账号密码暂时保存等下次登录时可以不用再次输入：saveUserInfo(Activity名,用户名,密码)3.2.1.8限制条件必须在有网的条件下能使用登录功能。3.2.2人员管理3.2.2.1设计图3.2.2.2功能描述通过手持设备扫描员工的RFID号，并在员工工号的输入框手动输入员工工号，并将两条数据上传到服务器中的数据库。将员工工号与RFID号相互绑定。3.2.2.3输入数据变量名属性说明numberstring员工的员工号(必填)rfidstring员工的RFID号(必填)如：E2005032530B0187144085E3在检测数据的有效性是像是判断数据是否为空，当向服务器发送消息时服务器会对数据进行有效性检测，显示判断员工的员工号是否存在，员工的RFID号是否已被其他工作人员应将绑定。这些数据的获取离不开具有RFID扫描功能的手持设备，对员工的RFID卡进行扫描获取RFID号。才实现此功能3.2.2.4输出数据变量名属性说明numberstring员工的员工号rfidstring员工的RFID