摘要：如果你新加入一个项目的开发,在交接文档不齐全的情况下,相信少不了无从下手的烦恼,为了解决这个问题,本文对项目交接文档做一个简单的约定(InspiredBy项目交接中所踩的坑&;全栈指引平台)。项目相关资源说明:介绍项目开发所涉及的资源,包括代码和文档地址(从地址可以看出代码管理工具是git还是svn)、系统登录地址及账号(如果已上线的话)、对接人员等。示例:代码路径:文档路径:系统登录地址:账号&;密码:对接人员:交互:前端:后台:PD:安装调试说明:介绍环境
如果你新加入一个项目的开发,在交接文档不齐全的情况下,相信少不了无从下手的烦恼,为了解决这个问题,本文对项目交接文档做一个简单的约定(Inspired By 项目交接中所踩的坑 &; 全栈指引平台)。
项目相关 资源
说明:
介绍项目开发所涉及的资源,包括代码和文档地址(从地址可以看出代码管理工具是 git 还是 svn)、系统登录地址及账号(如果已上线的话)、对接人员等。
示例:
代码路径:
文档路径:
系统登录地址:
账号 &; 密码:
对接人员:
交互: 前端: 后台: PD: 安装调试
说明:
介绍环境依赖及安装方法,并且:
用 Just 构建的,参考 Just 快速上手给出简要 init 过程 需要配置 host,给出 iHost 工具及使用说明 和后台对接的,参考 关于前后端分离的一些思考一文,给出具体方案 使用反向代理的,给出配置文件
示例:
下载和安装 Node(version >= 4.0) 安装 tnpm npm install -g tnpm --registry=http://registry.npm.alibaba-inc.com(如果报错,请先运行 sudo chown -R $USER /usr/local) 从代码库更新代码 git clone xxx 安装依赖 cd xxx &;&; tnpm install 运行 tnpm run dev,访问 http://127.0.0.1:xxxx 代码相关 代码结构说明
说明:
介绍每个有可能被二次改动的目录及文件的作用
示例:
--project |--src(源代码目录) |--common(通用组件库,包括通用网络请求、工具函数等) |--lib.js |--util.js |--component(业务组件库,可通过文件结构划分业务逻辑模块) |--index.jsx |--index.less |--entry(入口文件,可以有多个) |--index.jsx |--.eslintrc(提交前的语法配置检查) |--.gitignore(git 提交的文件过滤配置) |--package.json(项目信息文件,包括依赖包和构建命令) |--index.html(调试的入口页面) 技术栈及快速入门
说明:
介绍开发涉及的环境、工具、语言,并对需要项目交接人员深入了解的部分给出快速上手文档,因为你不能保证新加入项目的成员对这些技术都了解,根据你的经验给出入门文档可以帮助他们节省很多时间。
示例:
环境:
node 环境搭建 tnpm 官网
构建工具:
Just Just 快速上手 Webpack Webpack 傻瓜式指南 Gulp Gulp 入门教程
代码管理工具:
gitlab 使用 git &; gitlab
开发语言:
React 快速入门 React-Router react-router-tutorial Redux Redux 中文文档 ES6 ECMAScript 6入门和 React的ES5 ES6的语法对照参考
单元测试:
测试框架 Mocha 实例教程 should 语法 官网 开发相关 需要改动的代码位置
说明:
介绍需要添加或修改的代码所在目录位置和文件位置
示例:
vm 模板:
修改 a/b/c/auth.vm 修改 a/b/c/authMobile.vm
js:
在 public/js/ 下新建 auth.js 文件
css:
修改 public/css/auth.css 修改 public/css/authMobile.css 部署上线
说明:
介绍项目部署和上线的流程
示例:
本项目为纯前端资源,部署上线可参考:
前端应用申请
前端应用发布
一个典型操作的完整流程
说明:
如果是一个规模庞大,持续时间长,参与人员多的项目,提供一个典型操作的完整流程是很有必要的。比如对于 DPL 项目,可以提供一个简单组件的开发过程。
示例:
(以开发一个企业应用前端服务化组件为例)
搭建环境:
安装 node 和 tnpm 全局安装 seek-bin 脚手架: tnpm install @ali/seek-bin -g
开发组件:
a. 为组件创建目录,运行脚手架
mkdir 组件名称 (如果是系统组件,推荐 系统名-组件名,组件名第一个字母大写) cd 组件名称seek-bin init
b. 脚手架目录说明
doc 使用文档 lib 组件依赖库 src 组件源码
c. 组件调试
运行 seek-bin server会自动打开浏览器页面调试
d. 组件发布
tnpm publish 常见问题
说明:
对项目开发时的常见问题做一个总结,并给出解答。
示例:
a. 安装 tnpm 时报错
如果出现了类似 Error: EACCES: permission denied的错误, 执行 sudo chown -R $USER /usr/local然后重新执行安装命令
b. 运行 tnpm run dev报错
1)如果遇到提示 can not find module xxx或类似未找到 module 的报错,说明在运行 tnpm install 安装时候可能没有成功,可以尝试单独安装模块解决这个问题,即 tnpm install xxx
2)遇到 Error: listen EADDRINUSE :::8000(或者其他数字) 说明已经启动了一个 server,相应 8000 的端口被占用了,你可以找到之前开的 server, control + c然后重新 run dev; 如果找不到之前开的 server,请先使用 lsof -i tcp:8000找到进程号 PID,比如 12642,再执行 kill 12642来结束该进程。
一、营销部分要交接清楚以下内容：
1、项目名称，客户公司名称
2、项目类型，网站，还是微信，还是APP。
3、项目需求功能，原型设计图。
4、项目设计需求。
5、客户联系方式，客户负责人
6、项目相关的其他内容，如是否需要注册域名，空间或服务器，是否需要申请APP市场帐号，是否有LOGO，是否有相关资料等。
二、项目交接之后要进行的工作：
1、项目助理首先要与客户取得联系，说明自己的职位和姓名，告知客户项目已由项目部接手，接下来的工作将由我们与您沟通来完成。
2、项目助理要熟悉整理，并与客户确认项目需求，做到自己对项目全部了解，清楚项目功能范围。
3、 设计师要与客户进行设计沟通，确认设计需求，完成页面设计，除超出预定需求或其他不属于设计师本职责范围的工作外，设计师应尽最大能力来完成项目的设计工作，不得推脱给其他人。
4、设计师要在两个工作日内做出设计工期预计，并提供给项目助理。
5、开发人员应该根据功能需求在两个工作日内做出开发工期计划预计，并提供给项目助理。
6、项目助理 根据设计和开发提供的工期，进行工期细分，要在三个工作日内完成项目工期 计划表，甘特图的形式。
7、项目助理公布最后的工期计划，并发给客户。开始进行项目实施。
8、项目助理每周为客户提供一份项目进度总结。
本文来自 铭泰华信 的CSDN 博客 ，全文地址请点击：https://blog.csdn.net/yh_bxhl/article/details/20650629?utm_source=copy