软件文档的编写说明
软件文档可以选择设计说明书、用户手册(使用说明书),理论上需求文档也可以提交。
设计说明书这个没什么固定的格式,合理即可。只要看上去不是明显的东拼西凑,能体现出这个软件是个真的即可。
设计说明书提纲

1 软件介绍
1.1 开发目的
和申请表上的开发目的一致。
1.2 面向领域/行业
和申请表上的面向领域/行业一致
1.3 软件的主要功能
和申请表上的软件的主要功能一致。
1.4 软件的技术特点
和申请表上的软件的技术特点一致。
1.5 升级说明
如为设计版软件(例如V2.0),需详细填写此部分。
2 软件开发信息
本部分可有可无,如果需要,必须和申请表一致。
2.1 开发完成日期
2020-01-01
2.2 首次发表日期和地点
2020-01-01
中国,上海,浦东。
2.3 著作权人
和申请表上的名称、顺序一致。
3 开发与运行环境
3.1 开发环境
3.1.1 开发的硬件环境
和申请表一致。
例如:
CPU 2GHz以上,内存4GB以上,硬盘20GB以上。
3.1.2 开发该软件的操作系统
和申请表一致。
例如:
Windows 10 家庭版。
3.1.3 软件开发环境 / 开发工具
和申请表一致。
例如:
Code::Blocks;Notepad++
3.2 运行环境
3.2.1 运行的硬件环境
和申请表一致。
3.2.2 该软件的运行平台/操作系统
和申请表一致。
3.2.3 软件运行支撑环境/支持软件
和申请表一致。
4 软件架构
4.1 软件架构
介绍软件的功能,绘制模块框图。
4.2 文件结构
介绍软件源程序的文件结构,可绘制框图。
4.3 数据库结构
介绍软件的数据库结构,可绘制框图。
4.4 运行原理
介绍软件的运行原理,也可根据需要自定第四章的各节标题。
5 函数说明
自第五章开始,可根据需要调整,以下为参考案例。
5.1 核心函数
5.2 通用函数
5.3 专用函数
6 接口说明
6.1 通用接口
6.2 专用接口
7 二次开发
7.1 模块设计方法
7.2 二次开发指引
8 安装与升级
8.1 安装部署方法
8.2 升级方法
8.3 服务器迁移方法
9 常见问题
用户手册用户手册(使用说明书)提纲
和使用说明书大同小异,只是需要详细的软件界面截图,截图要完整,例如网页类软件截取整个浏览器窗口,PC客户端截取全屏,手机APP截取手机全屏(安卓软件只截安卓,苹果只截苹果,不能混淆)。
1 软件介绍
1.1 开发目的
1.2 面向领域/行业
1.3 软件的主要功能
1.4 软件的技术特点
1.5 升级说明
2 软件开发信息
本部分可有可无,如果需要,必须和申请表一致。
2.1 开发完成日期
2.2 首次发表日期和地点
2.3 著作权人
3 开发与运行环境
3.1 开发环境
3.1.1 开发的硬件环境
3.1.2 开发该软件的操作系统
3.1.3 软件开发环境 / 开发工具
3.2 运行环境
3.2.1 运行的硬件环境
3.2.2 该软件的运行平台/操作系统
3.2.3 软件运行支撑环境/支持软件
4 安装说明
5 使用说明
5.1 注册
5.2 登录
5.3 ……
6 卸载说明
7 升级说明
8 常见问题