计算机设计大赛 | 开发文档编写参考（完善中）

1. 需求分析

填写说明：本部分内容建议不超过1000字，以300字以内为宜，简要说明为什么开发本作品，是否存在竞品，对标什么作品以及面向的用户、主要功能、主要性能等。建议有竞品分析表格，从多个维度分析本作品与竞品作品比较。

Tips：

• 需求分析总是从用户的具体问题或情景出发，扩展（发散）到相关市场和竞品的分析，最后再聚焦回具体的产品需求分析

1.1 开发背景

以故事的形式引入

描述产生一个具体需求的情景

简要说明项目的目的

1.2 市场分析

市场分析要结合具体的数据说话

1.2.1 目标用户

用户画像要描述精准（年龄、性别、工作状况、兴趣等）

1.2.1 市场规模分析

多用饼图、柱状图或折线图

1.2.2 竞品分析

使用表格分析

1.3 作品简介

1.3.1 主要功能

简要描述产品的功能及其实现的客户价值

1.3.2 优势和创新点

阐述技术上或商业模式上的创新点

2. 概要设计

填写说明：将需求分析结果分解成功能模块以及模块的层次结构、调用关系、模块间接口以及人机界面等，建议用图体现内容，不宜全文字描述。建议图文总体不超过A4纸两页，以1页为宜。

Tips:

• 架构图、流程图和模块关系等可用PowerPoint SmartArt和ProcessOn等工具绘制
• 一般的Web、APP、小程序等应用涉及前端（客户端）和后端（服务器端）开发，前端包含视图层和逻辑层，后端常用MVC架构（模型-视图-控制器），并且需要配置相应的数据库
• 物联网和涉及硬件的应用一般包含设备端、服务器端和客户端，设备为可联网的嵌入式设备，服务器端除Web后端、数据库外还常需搭建MQTT代理服务器等，客户端除面向普通用户的界面外还常常有用于实时监测和控制联网设备的管理界面

2.1 系统设计

软件要有架构图（层次图），涉及硬件或联网设备除架构图外还需要有拓扑图

2.2 模块设计

结合具体的用户界面（页面的原型图）和流程图（或示意图）说明产品的功能

3. 详细设计

填写说明：包括但不限于：界面设计、数据库设计(如果有)、关键算法。界面设计建议用作品实际界面，建议包括典型使用流程；数据库设计建议用表格、ER图或UML方式，说明文字简明扼要，违背范式的设计建议说明理由；关键算法可以替换为关键技术、技术创新等。本部分不宜大篇幅铺陈，建议突出重点痛点难点特点。

Tips:

• 界面设计可用PS、Gravit Designer等平面设计软件，也可用快速原型工具，如Axure RP、墨刀、Mock Plus等
• 架构图、流程图以及ER图或UML等可用ProcessOn、PowerPoint SmartArt或Microsoft Visio等绘制

3.1 界面设计

界面是为功能服务的

应结合所涉及的具体界面说明产品的功能和用户的使用功能的流程

3.2 数据库设计

使用表格、ER图或UML说明数据库

3.3 关键技术

阐述实现本应用的关键算法、技术创新点等

4. 测试报告

填写说明：包括测试报告和技术指标。为了保证作品质量，建议多进行测试，并将测试过程、测试结果、修正过程或结果形成文档，也可以将本标题修改为主要测试，撰写主要测试过程结果及其修正；根据测试结果，形成多维度技术指标，包括：运行速度、安全性、扩展性、部署方便性和可用性等。本部分简要说明即可，减少常识性内容。

5. 安装及使用

填写说明：简要说明安装环境要求、安装过程、主要流程等。建议包含默认安装和典型使用流程。

Tips:

• 多参考github上的开源项目文档

6. 项目总结

填写说明：作品制作开发过程中的一些感悟和后续升级等，如：项目协调、任务分解、面对困难、水平提升、升级演进、商业推广等诸方面。建议部分篇幅不超过A4纸1页。