问题描述
开发平台独立的API文档有哪些工具？
What tools exist for developing platform indepedent API Documentation?
我正在设计一个提出的API，并希望以一个结构化的方式写文档可编辑的方式。我看到的很多答案基本上都是使用内置的语言特定文档工具，但由于我从顶级设计API，而不是实现它，这不是很有用。我正在寻找一个用于API文档的CMS
I'm in the process of designing a proposed API, and want to write documentation in a structured and easily editable way. A lot of the answers I've seen have basically been "Use built in language specific documentation tools", but since I'm designing the API from a 'top-level', rather than implementing it, this isn't so useful. I'm looking for a CMS for API Documentation
我已经看到使用PBWiki或Confluence的一些建议，但我不相信一个简单的wiki是最好的选择，虽然版本控制方面是不错的。
I've seen a few suggestions to use PBWiki or Confluence, but I'm not convinced that a plain wiki is the best option, though the version control aspects are nice.
理论上说，一个Drupal构建与CCK用于API调用和Views用于阅读API，但这对我正在寻找的一点点重要。
In theory, a Drupal build with CCK for API calls and Views for reading the API, but that's a bit of heavy lifting for what I'm looking for.
有没有一个API文档管理系统？编写和管理与平台无关的API文档的最佳选择是什么？
Is there a API Documentation Management System out there? What are the best options for writing and managing platform-independent documentation for APIs?
我看过，但还没有一个令人满意的答案。
I've seen the related questions for this, but there has yet to be a satisfactory answer.
推荐答案
任何结构化文本语言都可以。我会使用乳胶，troff是老派。
Any structured text language will do. I'd use latex, and troff is old school.
但是，您可能错过了使用doxygen或其他任何建议的观点。如果你这样做，那么编写文件是也放置脚手架以便最终实现。更好的是，示例文档将与最终的真实文档格式相同，您当然会使用源代码控制，不是吗？所以你会有一个盆栽的修改历史。
But you may have missed the point of the suggestion to use doxygen or whatever. If you do that, then writing the documentation is also laying down the scaffold for the eventual implementation. Better still, the example documentation will be in the same format as the eventual real documentation and, you will--of course---use source control on it, won't you? So you'll have a potted history of changes to the spec.
这篇关于用于创建API文档/提案的平台独立工具的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！