课程设计文档库

本仓库下存放在整个课程设计过程中产生的文档，用于指导和记录整个开发过程。

---

• 课程设计文档库
  • 1. 仓库目录结构简介
  • 2. 如何使用本文档库

---

1. 仓库目录结构简介

|-- images
|-- 计划与周报
|   |-- 分阶段计划.md
|   |-- 周报.md
|   `-- 项目总计划.md
|-- 需求与设计
|   |-- 总体设计文档.md
|   |-- 数据库设计文档.md
|   |-- 详细设计文档.md
|   |-- 需求说明文档.md
|   `-- 软件设计原图
|-- 环境搭建与技术说明
|   |-- images.xml
|   |-- GroupNineStyle.xml
|   `-- 开发环境配置指南.md
|-- Java-编码规范.md
|-- README.md
|-- 文档写作指南.md
`-- 文档及代码协作指南.md

其中：

• 『images』目录存放文档中使用到的所有图片。
• 『计划与周报』目录存放项目总计划，分阶段计划，周报。
  • 项目总计划.md：描述项目的总体框架及安排。
  • 分阶段计划.md：描述更加细致的小阶段计划，通常以技术模块为单位。
  • 周报.md：描述每周的总结评价。
• 『需求与设计』目录存放需求分析与设计阶段产生的文档，这也是最终要上交的文档；
  • 『软件设计原图』子目录存放数据库设计软件以及 UML 建模软件工作的二进制文件；
• 『环境搭建与技术说明』目录存放开发环境搭建及实现过程中需要用到的一些主要技术的讲解
  • 『images.xml』为 Tomcat 配置图片存放目录的配置文件。
  • 『GroupNineStyle.xml』为项目 eclipse 代码规范配置文件。
• 『根目录』下为各种指南和规范；

2. 如何使用本文档库

在使用本文档库前，请确保理解『文档写作指南.md』与『文档及代码协作指南.md』所陈诉的各使用建议与规范。