前端项目交接文档

前言

项目交接文档,应从项目立项之初就可以开始写。
而不是等到项目交接时才写。
因为那时写,已错过很多细节。
这些细节可能是高质量交接的关键。

业务理解

理解业务的基础上,对于需求的实现或bug修复,做出的技术判断,坑更少。
可以知道需求合理性,需求实现的难度,需求实现的可扩展性。

必要的地址

  • 前端代码托管地址
    现在一般用GIT来对前端代码做版本控制。
    大公司一般自己内部搭建gitlab系统。
    小公司基本购买私有git库。比如conding.netgithub私有仓库

  • 后端代码托管地址
    老项目,老后端不二话,SVN。
    潮一点,GIT。

  • 视觉稿/交互稿地址
    老早以前视觉稿是PSD。
    现在老早是Sketch,再通过Marketch来导出带有标注信息的稿子。

接口定义

除了接口地址,就是返回格式定义了。
正常有数据返回

{
    content: {},
    success: true,
    errorCode:"",
    errorMsg: "",
    csrfToken:"", // 防伪造请求
}

正常空数据返回

{
    content:null,
    success: true,
    errorCode:"",
    errorMsg: "",
    csrfToken:"",
}

异常数据返回

{
    content:null,
    success: false,
    errorCode:"E404",
    errorMsg: "Interface not found!",
    csrfToken:"",
}
  • 日常测试地址,预发地址,线上地址
    三者环境的区别另说。

项目管理系统地址

业务或者产品提出的需求列表(需求的时间,描述,完成情况)
测试或者他人提出的bug列表(bug出来的时间,描述,完成情况)

构建打包方式

我们知道seajsrequirejsbackboneangularJSReactJS组织代码的方式各不同。
我们还知道gruntgulpwebpack打包配置方式不一样。
还需去各自官网理解框架和打包的使用方式。

调试方式

调试方式也因项目而异。
一般来说线上运行的代码都是压缩混淆过,然后代理到本地对应的inline-source-map文件即可调试。
JavaScript Source Map相关信息,
可参考阮一峰文章JavaScript Source Map 详解
webpack文档Webpack devtool

代码版本控制策略

基本上有个日常开发分支,线上发布分支。
commit信息提交规范。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容