Ask HN: Which good software documentation solution would you suggest?

Posted by asiddique on Thursday February 23, 2017 @01:10PM
from the ask-hn dept.

Hello,

Lately I am looking for a good software for API documentation.

There are a lots of solutions out there and I cannot set up my mind to anyone, neither I have used any software documentation before so I am not experienced in this field.

Any suggestion? Even paid one are okay! Thanks :)!

Sid

p.s. My apologies if there are any english errors as it's not my mother-tongue.

( 1 comment | on HN )

Re:Ask HN: Which good software documentation solution would ... by dozzie on Thursday February 23, 2017 @01:55PM (#13716622)

Isn't it obvious? Use the one for your language. If you write in Java, JavaDoc, for C or C++ there's Doxygen, Erlang has its EDoc, Perl commonly uses POD, Python usually is documented with its native docstrings extracted by Sphinx. This way your API and documentation sources for it resides in the same place.

Also, much depends on what you expect from the tool, as there are approaches that decouple documentation from code.

[ Parent | on HN ]