Ask HN: What tools do you use to write API documentation

Posted by feverishaaron on Friday October 26, 2012 @02:09PM
from the ask-hn dept.

We are getting ready to write and deploy the documentation for our API. We have several SDKs in multiple languages that we need to document. We also need a centralized CMS-like repository that isn't tied to our application.

So what does your company use? Are there any favorite CMS or wikis? Is there one auto-documentation system that will generate from multiple languages?

( 3 comments | 2 points | on HN )

Re:Ask HN: What tools do you use to write API documentation by eschutte2 on Friday October 26, 2012 @02:30PM (#4703528)

We've been pretty happy with Dokuwiki and NaturalDocs plus a custom pipeline to process the NaturalDocs output.

https://www.dokuwiki.org/dokuwiki

http://www.naturaldocs.org/

Example: http://learn.springbase.com/api:company

[ Parent | on HN ]

Re:Ask HN: What tools do you use to write API documentation by pborenstein on Saturday October 27, 2012 @03:43AM (#4705674)

We use Restdown for REST API doc. https://github.com/trentm/restdown

For topic documentation we use Confluence, but not particularly enamored with it.

[ Parent | on HN ]

Re:Ask HN: What tools do you use to write API documentation by saiko-chriskun on Thursday November 08, 2012 @05:11PM (#4760167)

http://swagger.wordnik.com ;)

Auto-generates from a json response on our server.

[ Parent | on HN ]