平台能力维度文档

需要提供一份以平台能力为维度的文档，涵盖技能的所有部分。

一份文档应该包含哪些内容？

0. 前后契约

0.1 功能契约

0.2 外部接口契约

0.3 服务契约

定义好服务的以下内容：

• 参数；

• 参数类型；

• 参数名称；

• 参数个数等。

1. 数据模型

包括以下内容：

• 字段名称；

• 字段类型；

• ER 关系等。

2. 界面布局

包括以下内容：

• 表格；

• 表单；

• 搜索。

2.1 表格

明确表格需要展示哪些字段，以及字段对应的颜色、标签等。

2.2 表单

明确表单字段的展示形式，例如某个字段使用下拉框。

2.3 按钮与弹窗

包括以下内容：

• 按钮；

• 按钮对应的弹窗；

• 弹窗的布局；

• 弹窗需要获取的主表字段；

• 按钮的交互流程。

3. 后端功能

描述服务的详细业务。

3.1 表格查询服务

明确以下内容：

• 入参；

• 返回字段。

3.2 外部接口调用

某个服务涉及查询外部接口时，需要明确以下内容：

• 外部接口的入参；

• 外部接口的返回参数；

• 调用方式是异步还是同步。

4. 架构与规范

包括以下内容：

• 架构图；

• 代码项目结构图；

• 命名规范；

• 框架选型等。

如果项目有需要，可以增加相应内容。