帮助文档的数据库结构

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

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

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

【2月7日 修改】 

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

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

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

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

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

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

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

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏前端萌媛的成长之路

为什么要使用css-sprite

28530
来自专栏前端新视界

如何编写通用的 Helper Class

Github: https://github.com/nzbin/snack-helper Docs: https://nzbin.github.io/sn...

22880
来自专栏微信终端开发团队的专栏

Android微信上的SVG

资源矢量化 “清晰”和“体积”的矛盾与麻烦 面对android的各种dpi某事,想要所有设备上的图片都能有最清晰的效果,就意味着每种dpi模式都必须提供一份对应...

44250
来自专栏BestSDK

20个对前端开发人员有用的文档和指南

是时候来更新一下我们需要选择的工具或技术了。请欣赏我们的文档和指南系列的第五部,别忘了让我们知道任何其他我们尚未列入该系列的其他文档或指南。 1.SitePoi...

25570
来自专栏CDA数据分析师

有Bigger | 打造属于自己的 Python 编码环境

一个好的程序员必须善用各种工具提升自己的开发效率,和提升自己的幸福指数。另外,个人觉得vim还是值得自己重新一配的,我的配置过程基本都是在 读spf13的配置,...

22450
来自专栏互联网杂技

20个为前端开发者准备的文档和指南8

1.Meteor: The Official Guide(Meteor官方指南) Meteor介绍的链接地址: http://www.geekpark.net/...

38050
来自专栏互联网杂技

20个为前端开发者准备的文档和指南2

1.CSS Vocabulary(CSS词汇表) (需自备墙梯才可以访问) 点击该应用,将会使你了解到CSS语法所有不同的部分,和它们对应的属性名是什么。 ? ...

374100
来自专栏开源优测

哪些年从事自动化测试需要经历的往事

在实战中,又去接触了watir,即ruby版的selenium,又是一通的直接看源码,顺便学习和了解ruby

11020
来自专栏数据小魔方

学会自定义主题,让你的仪表盘瞬间高逼格~

今天这一篇跟大家介绍如何在PowerBI和Tableau中自定义主题来更换默认主题,让你的仪表盘随心所欲的变换主题。 关于Excel的主题配色相关内容已经推送过...

52870
来自专栏互联网杂技

20个为前端开发者准备的文档和指南5

1. Loupe 它是“一个小型可视化工具,可以帮助你理解JavaScript如何相互调用 stack(栈)/event loop(循环事件)/callback...

38670

扫码关注云+社区

领取腾讯云代金券