用於創建API的平臺無關工具文檔/建議

Question

開發平臺獨立API文檔有哪些工具？

我正在設計一個建議的API的過程中，並希望以結構化和易於編輯的方式編寫文檔。我見過的很多答案基本上都是「使用內置語言特定的文檔工具」，但是由於我是從「頂級」設計API而不是實現它，所以這不是很有用。我正在尋找一個用於API文檔的CMS

我已經看到了一些使用PBWiki或Confluence的建議，但我不相信普通wiki是最好的選擇，儘管版本控制方面很好。

從理論上講，Drupal構建的CCK API調用和視圖讀取API，但這對我所尋找的東西有點繁重。

是否有API文檔管理系統？編寫和管理API平臺無關文檔的最佳選擇是什麼？

我已經看到了這個related questions，但還沒有一個滿意的答案。

Answer 1

任何結構化文本語言都可以。我會用乳膠，troff是老派。

但您可能錯過了使用doxygen或其他方法的建議。如果你這樣做，那麼編寫文檔也放下腳手架最終實施。更好的是，示例文檔的格式與最終的real文檔相同，您當然會使用源代碼控制，不是嗎？所以你會有一個盆栽的規範變化的歷史。