组件封装流程以及成果物标准

赢海

组件封装流程

组件封装成果物

1. 设计需求文档
2. 实现方案技术文档
3. 组件集成demo
4. 组件集成readme

赢海组件封装要求

一、设计需求文档要求:

为明确组件封装功能要求以及快速给出设计方案

1. 需要明确组件封装功能需求
2. 需要标注组件细节点交互以及逻辑需求
3. 明确组件实现最终效果以及预期目标

二、实现方案技术文档:

根据设计需求来调查对应技术文档实现以及可落地方案

1. 需要明确技术方可行性方案以及可落地方案
2. 需要思考是 模块组件/模块组件
3. 根据不同方案给出需要花费的人工成本
4. 分析出不同方案的优缺点差异
5. 明确你的组件的生命周期（何时创建，何时加载，何时更新，何时销毁）
6. 明确你的组件的设计模式（单例，工厂）
7. 组件内部运转机制要抽象合理

三、组件使用文档要求:

为了组件接入宿主更加顺畅，降低接入中的沟通成本，组件须提供完善的接入指导文档，包含以下内容：

1. 集成的详细步骤，包括添加依赖的库文件，工程配置的详细步骤（截图说明）；

2. 组件初始化的详细说明，如：初始化时机，初始化方法调用，对象销毁等。

3. 组件使用配置详细说明，如：调试开关，网络环境配置。

4. 提供完整的API调用说明文档。

   a. 对于API的调用各个入参，出参有完整的说明。

   b. 文档要求与最新版组件保持一致。

   c. 文档中必须包含接入组件的受限项和特定的接入要求。

   d. 文档中必须说明可能产生冲突的情形并且如何避免的技术方案。

5. 对于组件中依赖的第三方库和系统公共库，必须有完整的依赖列表。

四、组件 README要求：

1. 当前组件版本号；

2. 标明当前组件版本的功能；

3. 标明当前组件版本与之前组件版本之间的差异，包括接口文件的添加、移除；

4. 标明Bug修改以及优化记录；

5. 文档末尾标明技术对接人的联系方式（邮箱，电话）。

五、组件 Demo要求

1.demo必须可正常编译通过，可以正常运行。

2.demo必须针对最新版本的组件。

3.demo工程清晰的展示组件的环境部署，初始化和所有API的功能调用。

4.demo必须清晰的展示组件的资源回收方式，以及销毁工作。