README文档说明撰写规范 - 图1

一、 项目说明

  • 项目名:XXXX
  • 简要说明:xxxxxxxxxxxxxxxx

二、关联文档

  • PRD:
  • 原型图:
  • 设计图:
  • 设计文档:
  • 接口文档:
  • gitee/github 代码地址:
  • 上线地址:
  • shopify后台:
……

三、使用技术

3.1 主要技术栈

  • Remix、React、TypeScript

3.2 使用到的第三方库

第三方库 版本 用途
axios 1.6.8 常用于发送 HTTP 请求和处理响应数据
xxx x.x.x xxxxxxx

四、开发步骤

4.1 环境准备

  • node 版本

4.2 项目启动

五、 部署构建流程

5.1 分支说明

5.2 CI/CD说明