README规范

项目名:[project name],git仓库地址:[repository’s url from origin] 。本项目第一负责人为 [owner]

1. 如何运行

node版本 [xxx]

1.1 开发环境配置

xxxxxx

1.2 开发过程

1.2.1 命令

# 开发
npm start

# 发布
npm run build

1.2.2 代理配置

Fiddler 代理:

  • regex:^https?://now\.qq\.com/(.*\.(js|css|png|jpg|gif|jpeg|svg|blob).*)$ ROOT:/path/$1

Whistle 代理:

  • /^https?://now\.qq\.com/(.*\.(js|css|png|jpg|gif|jpeg|svg|blob).*)$/ ROOT:/path/$1

1.3 发布

发布产品 发布模块
[xxx] [xxx]

发布时的备注

1.4 错误告警及监控

1.5 CGI

CGI 描述 CGI开发人员
xxx XXXX xxx
xxx XXXX xxx

1.6 相关人员

角色 人员
产品经理 xxx,yyy
前端开发 xxx
后台开发 xxx,yyy,zzz
交互设计 xxx,yyy

1.7 其他

2. 业务介绍

2.1 xx业务入口

入口地址为 xxx,目前有哪些渠道:

  1. AAA
  2. BBB
  3. CCC
页面目录 页面描述 页面链接 参数描述
index 首页 https://now.qq.com

2.2 xxx 入口

3. 其他

XXX

项目备注