帮助文档的数据库结构

 

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

 

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

 

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

 

      

 

【2月7日 修改】 

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

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

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

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

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

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

 

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

 

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