开发规范

# 归档管理

.
├── 业务
│   ├── a
│   │   ├── a1
│   │   ├── a2
│   │   └── a3
│   ├── b
│   └── c
├── 迭代
│   ├── 2021
│   ├── 2022
│   │   ├── 202201
│   │   ├── 202202
│   │   ├── 202203
│   │   │   ├── xxx
│   │   │   └── yyy
│   │   └── 20220x
│   └── 202x
└── ...

# 业务说明文档

每个业务说明文档主要包含几块内容：概要、术语、功能、开发和版本

  • 概要：一句话介绍业务
  • 术语：业务术语说明
  • 功能：可以以思维导图的形式组织业务工能点
  • 开发：相关项目的源码仓库和访问地址，以及访问路径
  • 版本：关联项目的版本迭代记录，见下文

# 版本迭代记录

每个版本迭代记录包含需求分析、概要设计和详细设计。

  • 需求分析：主要记录下需求、原型、设计稿和接口文档，然后对存在的技术难点和遗留问题进行说明，最后进行任务拆解和工时评估

    • 技术难点：对技术难点的记录说明

    • 依赖问题：对于一些旧项目，可能存在一些遗留问题

    • 任务工时：

      项目 模块 子模块 开发者 工时（小时/天）
      开发 列表页面 1、信息流数据加载逻辑：0.5D
      2、信息流交互和异常：0.5D
      3、信息流卡片：0.5D      		 张三 1.5D
      测试 0.5D
      合计 2D

  • 概要设计：主要是项目服务和功能点的罗列。

  • 详细设计：可以是一些项目结构、路由路径和组件拆分的设计。

← vue2 →