换了工作半年多了,这半年在接手项目时,总得找上一个人问这,问那,问的我都不好意思 ,于是想要是有个文档的话,就不会这么麻烦,最起码,在我手上的项目交给别人时,省掉这些麻烦,于是有了下面的模版:
一、项目前提 |
---|
1、项目介绍:一个金融类的 app ,原生与 web 相结合开发; |
2、项目类型:原生开发☐ web 开发☐ 原生+web 开发☑ |
3、登陆账号(测试): |
有☑a、账户:admin 密码:123 b、文档提供(证书) |
没有☐ |
4、上线 |
是☑Android :打包签名:key、valueiOS :开发者账号 |
否☐ |
二、项目设计 |
---|
1、 App (提供材料) a、 原型图b、 需求文档 c、 设计文档 |
2、 项目流程图 例如: |
3、 用到的第三方库: 例如: |
友盟统计 com.umeng.analytics:analytics:latest.integration |
微博 sdk weiboSDKCore_3.1.4.jar’ |
快速开发库、里面提供了快速的网络请求、图片加载、数据库 操作、以及 UI 的绑定org.xutils:xutils:3.3.36’。。。。。 |
三、与后端的对接 |
1、 原生app 后端提供的接口文档:有☐ 没有☑ |
2、 混合型的app web+原生 |
1)url 入口 例如:a、 json 文件中获取:http://app.loyalwm.com/rongyi.json b、 测试入口: http://app.loyalwm.com/login_out |
2)app 实现 web 的接口 例如 |
android :提供 name、方法 name:ApplicationSelectImg(标示 android 、与 web 间的相互调用) 方法:ResetGestureAndroid()//重置密码gestureAndroid(final String num, final String uid)/设置手势密码SelectImg(String uid) //修改头像iOS 提供链接:如上图所示:”app://GesturePassword?resetGesturePassword” |
3)原生界面 解锁页面、设置头像 |
3、 web 端 app url 入口 |
四、开发进度 |
未完成: ☐ 说明:() 基本完成:需要调 bug ☐说明: 完成上线:☑ |
总结:自己在写代码的时候,文档要时刻补充;利于修复;