用于创建API文档/提案的平台无关工具

时间:2010-06-28 02:12:57

标签: api documentation api-design

开发平台独立API文档有哪些工具?

我正在设计提议的API,并希望以结构化且易于编辑的方式编写文档。我见过的很多答案基本上都是“使用内置语言特定的文档工具”,但由于我是从“顶层”设计API而不是实现它,所以这不是那么有用。我正在寻找用于API文档的CMS

我已经看到了一些使用PBWiki或Confluence的建议,但我不相信普通的wiki是最好的选择,尽管版本控制方面很好。

理论上,Drupal使用CCK进行API调用和使用Views来阅读API,但这对我正在寻找的东西来说有点沉重。

那里有API文档管理系统吗?编写和管理API的平台无关文档的最佳选择是什么?

我已经看到了related questions,但还没有一个令人满意的答案。

1 个答案:

答案 0 :(得分:3)

任何结构化文本语言都可以。我使用乳胶,而特劳夫是老派。

但你可能已经错过了使用doxygen或其他任何建议的观点。如果你这样做,那么编写文档为最终实现奠定了脚手架。更好的是,示例文档的格式与最终的真实文档的格式相同,当然,您将使用源代码控制,不是吗?因此,您将获得规范变更的盆景历史记录。