如何阅读模块手册的文档

模块就是一些 信息结构图,接口,元素,视口的集合.并且是对某个功能的完整实现.然后先对模块建立一个整体认识如前文所列举模块主要有以下内容(不同模块根据自身需要会包含所有或者部分内容,详细参考模块说明文档):

模块/
   |___信息结构图: 展示了这个模块内部的信息结构图设计
   |          
   |___接口列表: 提供的可以直接用于数据绑定或者提交数据的后端视口
   |
   |___UI列表: 列举了模块中所包含哪些 UI 元素可以直接利用的.
   |        |
   |        |___元素列表: 基于本模块所提供的元素,通常数据绑定已经完成了.
   |        |
   |        |___视口列表: 基于本模块提供的视口,通常数据绑定已经完成了.可以直接作为页面的一部分使用
   |        |
   |        |___页面列表: 基于本模块的页面,通常数据绑定或者与后端的数据视口都以配置完成,可以直接作为产品页面来使用.
   |        |
   |___配置列表: 列举的是本模块正常工作的前提配置项.
   |        |
   |        |___站点配置: 本模块使用了哪些站点配置项,以及影响对象的解释
   |        |
   |        |___策略数据配置: 本模块使用了哪些策略数据配置项,以及影响对象的解释
   |        |
   |        |___web页面配置: 本模块提供了哪些配置页面,配置细节会在配置页面上给出详细解释
   |        |
   |___代码段列表: 基于本模块的代码段,以及代码段的功能简介.换句话说就是列表中的代码段必须加入本模块.


那么在阅读模块文档的时候,通常需要了解几个点:

  • (此模块设计目的是什么) | (此模块包含哪些功能)| (此模块解决什么问题)
  • 这个模块应该怎么用?
    • 第一,明确自己的需求
    • 第二,根据模块文档中所列举的内容去寻找接近需求的部分.可能是接口,可能是元素
    • 第三,按照模块文档使用