项目需求说明及可行性分析文档基本格式
一、文档基本格式:
(一)、项目说明及功能
可行性分析:
1、描述这个项目的主要功能:
也就是这个项目是做什么的,都有哪些功能?简单地综合介绍即可。
2、项目可行吗?
也就是介绍制作这个项目的原因。
为什么要开发这个项目,你的出发点是什么?这个项目有哪些受众会使用?反之,如果发现没有受众会使用这个app,那么这个app也就不存在制作必要,也就是不可行的了。
3、项目接口:
也就是返回数据的Url地址(一般都返回json数据或者xml格式的数据)。将这些url地址一一罗列清楚,每个地址有简单的文字说明。一般来说,如果没有服务器端的接口地址,那么这个app从技术上来说就不具有可行性。
(二)、项目分组情况:
将组员,各组员的分工情况进行说明。
(三)、项目介绍:
以图文并茂的形式对于app中各个页面进行说明。图片为项目截图,文字为页面的说明。
文字内容包括:
- 1、该页面的数据来源于哪个url接口;
- 2、该页面有哪些功能,用户可以做哪些操作;
- 3、该页面UI中用到哪些值得说明的控件或组件;
- 4、为完成该页面使用了哪些值得说明的技术或技巧。
(四)、接口参数介绍及返回JSON字符串的介绍:
以表格的形式,将接口Uri中的参数进行一一展示和介绍。如果该接口返回json字符串,要对json字符串的格式进行介绍。
示例如下:
1、 GET请求
参数 | 类型 | 说明 |
mobileType | String | 系统 |
city | int | 城市Id |
apiVer | int | 手机版本号 |
deviceId | String | 设备Id |
channel | String | 链接管道 |
ver | double | 客户端版本 |
2、返回数据(对象:data)
参数 | 类型 | 说明 |
retcode | String | 返回状态码 |
retdesc | String | 返回状态 |
activityList | 数组 | 广告ViewPager的内容集合 |
startupList | 数组 | 程序启动时的画面集合 |
3、返回数据(数组:activityList)
参数 | 类型 | 说明 |
startDate | String | 影片开播时间 |
picSmallPath | String | 小图片地址 |
locationType | int | 位置类型 |
name | String | 广告名称 |
picLargePath | String | 大图片地址 |
endDate | String | 影片停播时间 |
type | int | 影片类型 |
activityEndDate | String | 活动结束时间 |
url | String | 超链接地址 |
activityStartDate | String | 活动开始时间 |
4、返回数据(数组:startupList)
参数 | 类型 | 说明 |
startDate | String | 开始时间 |
name | String | 名称 |
picLargePath | String | 大图片地址 |
endDate | String | 结束时间 |
5、地址http://piao.163.com/m/movie/index_pic.html?
(五)、数据库表结构分析:
1、该app中哪个栏目要用到数据库;
2、数据库中表结构是如何设计的?以表格的形式介绍字段的名称、数据类型和字段说明。
(六)、项目技术难点及解决方案:
(七)、项目下一步规划:
良心的公众号,更多精品文章,不要忘记关注哈
《Android和Java技术栈》