网站建设软件拥有一份优质的技术文档是决定你的项目是否引人关注的重要因素。无论开源产品或面向开发者的产品，均是如此。好的文档应该是一整套有机的系统内容，能指引用户通过文档与API进行交互。
API(Advanced Programmers Interface,高级程序员接口)(注:API实际是指Application Programming Interface,应用程序编程接口;此处疑为原文错误,不过在VB中也可以这么说吧!)是一套用来控制Windows的各个部件(从桌面的外观到位一个新进程分配的内存)的外观和行为的一套预先定义的Windows函数.用户的每个动作都会引发一个或几个函数的运行以Windows告诉发生了什么.
1.加入人性化的因素
阅读技术文档枯燥乏味，自然不像坐过山车那样紧张刺激。不过，你至少可以通过加入一些人性化的因素，或者开开玩笑。给你的例子中的变量其一些好玩儿的名字吧，别老是把函数名称叫什么foo之类的，好让你的读者有焕然一新的感觉。至少，这可以保证你的读者不会读着读着就睡过去。
3.减少点击次数
开发者痛恨点击鼠标，这已经不是什么秘密了。千万别把你的文档分散在数以万计的页面当中。尽量把相关的主题都放到一个页面里。我们非常赞成使用“单页面大指南”的组织形式（链接），这种形式不仅能让用户纵览全局，仅仅通过一个导航栏就能进入他们感兴趣的任意主题，另外还有一个好处是：用户在进行搜索的时候，仅仅搜索当前页面，就能涵盖查找所有的内容。
4.不要在例子中包含抽象概念
你可以争辩说，我的API本身就是个抽象体，抽象就是它的特点。然而，当你在教会开发者如何使用的过程中，还是能不抽象就不抽象比较好。在你的文档中尽可能地举现实中的例子吧。没有哪个开发者会抱怨你举例太多的。实际上，这种做法能显着地缩短开发者理解你产品的时间。对此，我们的网站里甚至给出一个代码样例加以解释。
5.支持多种编程语言
我们生活在一个多语言的世界。如果可能的话，为你的API提供各种编程语言版本的样例程序，只要的API支持这些语言。多数时候，多语言的工作都是由客户端库来完成的。要知道，开发者要想掌握一套API，离开他们熟悉的编程语言，是很难想象的。MailGun’sAPI为此做出了良好的榜样。它提供了curl，Ruby，Python，Java，C#和PHP等多个版本供开发者选择。
6.包含适当的快速指南
万事开头难，开发者学习一套全新的API，不得不重新适应其全新的思维方式，学习代价高昂。对于这个问题的解决办法是：通过快速指南来引导开发者。快速指南的目的是让用户用最小的代价学习如何利用你提供的API干一些小事。仅此而已。一旦用户完成了快速指南，他们就对自己有了信心，并能向更加深入的主题迈进。
7.提供样例应用
在学习结束的时候，开发者希望能看到关于项目产品应用的大致蓝图。达到这一目的最好的办法，莫过于提供可运行的样例应用。我发现，应用程序代码是将API运行机理和系统整合融会贯通最好的办法。samplecodeinApple’siOSDeveloperLibrary则是这方面做得很好的，它包含了详尽的iOS样例程序，并按主题一一分类。
8.绝不放过任何边界情况
使用API开发应用，所能遭遇的最糟糕的情况，莫过于你发现了一个文档中没有提到的错误。如果你遇到这种情况，就意味着你不能确认究竟是你的程序出了错，还是你对API的理解出了错。因此，参考索引中必须包含每种假设可能造成的边界情况，不论是显示的还是隐式的。花点儿时间在这个上面，绝对能起到事半功倍的效果。
北京网站建设 北京网页设计 网站制作（www.bjycxf.com）
