xx项目开发设计文档

需求：需求链接

1 . 流程图

1.1 系统架构图（以下为参考案例）

1.2 系统流程图（以下为参考案例）

1.3 状态流程图（以下为参考案例）

2. 表结构设计（以下为参考案例）

2.1 活动表（本次新增的表）

-- auto-generated definition
create table activity
(id                      bigint unsigned auto_incrementprimary key,title                   varchar(255) default ''                not null comment '活动标题'
)comment '营销活动信息';create index IDX_CUSTOM_IDon activity (merchant_custom_id);create index merchant_idon activity (merchant_id);

2.2 用户行为记录表（增加了2个字段）

    create_at               datetime     default CURRENT_TIMESTAMP not null comment '创建时间',update_at               datetime     default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '更新时间'

3. 接口设计

3.1 order/create（新增接口）

接口地址（yapi / swagger / 接口文档）

3.2 refund/apply （修改）

接口地址（yapi / swagger / 接口文档）

4. 配置与中间件

4.1 配置

4.2 redis

4.3 mq

4.4 ES

4.5 定时任务

5. 注意事项

6. 回归范围

7. 存疑点（技术评审时需要讨论的点）

技术评审之技术文档的规范模板相关推荐

Atitit usrQBK1600 技术文档的规范标准化解决方案
Atitit usrQBK1600 技术文档的规范标准化解决方案 1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 ...
java编码规范文档下载_软件项目实训及课程设计指导——制定待开发项目中各种文档的规范...
软件项目实训及课程设计指导--制定待开发项目中各种形式文档的规范 1.制定对课程设计项目开发过程中的规范性要求 (1)从"形式"到"内容"两个方面控制和要求开发 ...
项目文档编写规范与代码规范
往往越是规模大的公司,其项目工作中的每一个环节都有相应的规范进行管理,这些规范都是都前辈呕心沥血,披荆斩棘所获的的经验总结,而非普通文书工作者的推猜可得. 当然,如果刚刚创业起步的小公司如能更早的抓住 ...
项目、企业文档命名规范
引言目的为了在信息交互过程中避免歧义.提高效率及版本控制的需求,能做到文档.配置项及项目信息的可识别.可追溯和可控制,以此提高公司信息系统的规范性.流程化和扭转效率,特制定此规范用以统一公司输出信 ...
Markdown文档书写规范
MarkDown 文档书写规范 MarkDown 越来越成为方便快捷有效的文档书写格式.尤其对开发者来说. 主要有两个地方用到: 项目的 README.md 文件是每个项目都应该有的一个项目说明文档, ...
中文技术文档写作规范【转载】
标题层级标题分为四级. 一级标题:文章的标题二级标题:文章主要部分的大标题三级标题:二级标题下面一级的小标题四级标题:三级标题下面某一方面的小标题原则一级标题下,不能直接出现三级标题. ...
技术团队如何维护文档
今天和大家说一个技术团队的老问题:一个长期持续迭代的项目,代码已经翻过很多次了,但是技术文档还是最初的样子,后来的技术人员依靠文档已经无法正确了解项目最初的样子了.或者是,技术文档写了很多,但是根本没 ...
微软语音AI技术与微软听听文档小程序实践 | AI ProCon 2019
演讲嘉宾 | 赵晟.张鹏整理 | 伍杏玲来源 | CSDN(ID:CSDNnews) [导语]9 月 7 日,在CSDN主办的「AI ProCon 2019」上,微软(亚洲)互联网工程院人工智能语 ...
Websocket 百万长连接技术，在石墨文档中的实践
今日推荐推荐一个 Java 接口快速开发框架干掉Random:这个类已经成为获取随机数的王者Docker + Intellij IDEA,提升 10 倍生产力!笑出腹肌的注释,都是被代码耽误的诗人! ...
微软语音 AI 技术与微软听听文档小程序实践 | AI ProCon 2019
演讲者 | 赵晟.张鹏整理 | 伍杏玲出品 | CSDN(ID:CSDNnews) [CSDN 编者按]9 月 7 日,在CSDN主办的「AI ProCon 2019」上,微软(亚洲)互联网工程院 ...

技术评审之技术文档的规范模板

xx项目开发设计文档

需求：需求链接

1 . 流程图

1.1 系统架构图（以下为参考案例）

1.2 系统流程图（以下为参考案例）

2. 表结构设计（以下为参考案例）

3. 接口设计

3.1 order/create（新增接口）

3.2 refund/apply （修改）

4. 配置与中间件

4.1 配置

4.2 redis

4.3 mq

4.4 ES

4.5 定时任务

5. 注意事项

6. 回归范围

7. 存疑点（技术评审时需要讨论的点）

技术评审之技术文档的规范模板相关推荐

最新文章

热门文章