软件设计文档总结

摘要:毕业设计文档总结。

目录

[TOC]

目录

文档版本描述

一、主要内容

背景和目的/必要性

需求描述

二、需求分析

国内外现状

  1. 搜集资料/参考文献
  2. 整理总结:思维导图、优缺点

功能需求

  • 用例图
  • 功能需求详情表:需求名称、优先级、详情

非功能需求

  • 稳定性、易用性、可扩展性、性能、自动化

  • 详情表

三、系统设计

系统框架示意图:用户(普通、管理员)、前端(输入输出)、后台

系统概要设计

  • 系统功能模块(划分)图:系统-子系统-功能模块
  • 功能模块描述:输入输出接口设计、功能模块描述

全局数据结构与接口设计

数据库设计

  • E-R 图
  • 数据库表设计:列名、数据类型、空、说明、主键

功能模块详细设计

数据结构与接口设计

算法设计
  • 模块流程图:Visio、processon.com、规范标准
  • [模块流程描述:step1、step2…]

四、系统(具体)实现

  • 语言、框架、IDE
  • 分支管理:Git、SVN
  • 开发规范和开发流程
  • 编程规范
  • 编译与部署

五、测试

模块/功能测试(unit test)

  • 测试用例表:编号、用例名称、预置条件、步骤、预期结果、实际结果、测试时间
  • 测试报告:测试目的

系统测试

  1. 回归测试
  2. 覆盖率测试
  3. 极限测试

六、待改进之处

  • Mantis 缺陷管理

七、参考文献

README/用户(使用)文档

  • 档案说明:icon
  • 介绍
  • 文件目录结构树状图:Linux的tree命令,默认不安装
  • 安装、设置、使用说明
  • Change Log/更新记录
  • ToDo List
  • FQA/常见问题
  • 版权声明、联络方式、致谢
0%