SDK应该包括什么东西

手册/FAQ (547) 2016-04-20 14:24:10

如果让你设计和开发一个SDK(软件二次开发包),你认为里面应该有什么东西?首先接口文件和库文件之类是必不可少的,否则别人用什么呢?但是单纯具有这些东西也是不够的。我认为还需要至少三样东西:帮助文档,开发示例工程和实用工具。

 

帮助文档就是SDK的使用文档,具体应该包括两种:接口说明手册和二次开发指南。接口说明手册就是介绍每个接口怎么用,二次开发指南就是从浅入深地介绍怎么使用SDK进行二次开发。举个具体的例子就是对于VC++使用者来说,接口说明手册就好比MSDN,二次开发指南就好比《VC++技术内幕》。事实上MSDN是我见过的写得比较好的接口说明手册。

 

单单有文档是不够的,还应该有开发示例工程。因为例子是最形象的学习材料。而且开发示例工程应该和二次开发指南的内容紧密结合。

 

实用工具在SDK中是属于有点额外附送的好东西。它体现的是对二次开发用户的一种体贴。何谓实用工具?就是用来协助用户方便进行二次开发的工具,比如二次开发向导、API搜索工具、软件打包工具等等。

THE END