帮助文档的数据库结构

简介:   自然框架一直没有完整的帮助文档,只是有几个简单的示例。这个就是差距呀,那么帮助文档要怎么写呢?有工具可以自动生成,但是总感觉自动生成的一点都不好用,自己都看不懂。既然要弄文档,那么弄出来的文档就应该能够让大家看着方便,能够看明白是怎么回事。

 

  自然框架一直没有完整的帮助文档,只是有几个简单的示例。这个就是差距呀,那么帮助文档要怎么写呢?有工具可以自动生成,但是总感觉自动生成的一点都不好用,自己都看不懂。既然要弄文档,那么弄出来的文档就应该能够让大家看着方便,能够看明白是怎么回事。

 

  MSDN是一种标准的帮助文档格式吧,只是我不大会看,或者说看着很头痛。学习jQuery,看了jQuery的chm的文档,结构还可以基本可以看懂。于是就想按照jQuery的chm文档的结构来做一个。但是已考虑细节就发现不行。jQuery的文档只有一种,那就是方法。没有属性、事件、委托等。但是自然框架里有这些呀,不弄出来就不够完善。

 

  于是有回过头来看看msdn。这里参照了吴旗娃的分页控件的帮助文档的格式,加了一些自认为可以增加阅读性的东东。弄出来了下面的数据表结构。

 

      

 

【2月7日 修改】 

  栏目名称:就是帮助文档了。

  栏目分类:共用函数、数据访问、分页控件、基础控件、元数据控件、页面基类等。

  帮助的分类:一般用法,类、委托、枚举,属性、事件、方法,等。

  详细介绍:就是详细说明了,这里侧重jQuery的chm的形式。

  参数详细:一个方法可能会有多个参数,所以单独做了个表,一对多。

  示例详细:一个方法也可以有多个示例。

 

  基本就是这样,栏目是大分类,栏目分类是中分类,都是一级的。帮助的分类是小分类n级的。详细介绍就是树叶了。

 

  看到dudu在过年的时候都没有休息,真的是佩服呀。

 

相关文章
|
7月前
|
数据库
Google Earth Engine(GEE)——全球树木异体测量和树冠结构(Tallo)数据库
Google Earth Engine(GEE)——全球树木异体测量和树冠结构(Tallo)数据库
84 1
|
7月前
|
数据库
生成数据库结构文档
生成数据库结构文档
|
5月前
|
Oracle 关系型数据库 数据库连接
|
6月前
|
存储 关系型数据库 MySQL
|
6月前
|
SQL 运维 数据管理
数据管理DMS产品使用合集之如何修改在结构设计中的基准数据库
阿里云数据管理DMS提供了全面的数据管理、数据库运维、数据安全、数据迁移与同步等功能,助力企业高效、安全地进行数据库管理和运维工作。以下是DMS产品使用合集的详细介绍。
141 4
|
6月前
|
存储 关系型数据库 MySQL
MySQL数据库——InnoDB引擎-逻辑存储结构(表空间、段、区、页、行)
MySQL数据库——InnoDB引擎-逻辑存储结构(表空间、段、区、页、行)
133 7
|
6月前
|
存储 缓存 监控
如何设计数据库结构?
如何设计数据库结构?【6月更文挑战第9天】
61 3
|
6月前
|
缓存 关系型数据库 MySQL
MySQL数据库——InnoDB引擎-架构-内存结构(Buffer Pool、Change Buffer、Adaptive Hash Index、Log Buffer)
MySQL数据库——InnoDB引擎-架构-内存结构(Buffer Pool、Change Buffer、Adaptive Hash Index、Log Buffer)
104 3
|
6月前
|
存储 关系型数据库 MySQL
MySQL数据库——索引(2)-B+Tree、Hash结构,索引分类(聚集索引、二级索引)
MySQL数据库——索引(2)-B+Tree、Hash结构,索引分类(聚集索引、二级索引)
91 1
|
6月前
|
SQL 关系型数据库 数据建模
Dify数据库结构导出到PowerDesigner
Dify是开源大语言模型应用开发平台,助力快速构建生成式AI应用。PowerDesigner是SAP的企业级建模工具,用于数据建模、业务流程建模和企业架构规划。通过PostgreSQL的`pg_dump`导出表结构到SQL文件,然后在PowerDesigner中导入生成物理数据模型,从而实现Dify数据库结构到PowerDesigner的迁移。
182 1