How to write good developer documentation

Question

Hello, I&rsquo;m trying to improve the documentation of our current product and we are moving away from confluence to git and markdown solution for our developers.What tools should i use and initially i was planning to use MDbook

zenosmosis · Accepted Answer

I find that Docusaurus docs usually are the easiest to follow when consuming them but I have no experience with creating them: https://docusaurus.io/

__warlord__ · Answer

When I need inspiration I always look at Kagi's documentation... https://help.kagi.com/kagi/welcome.html

suprjami · Answer

I love Markdown but it's probably not enough for this.
It's hard to give specifics without more info, but you want every API reference to link back to its definition.
Say a function is called like `function(arg1, arg2)` then I should be able to click on the arguments to go to their definitions.
You probably want to use Sphinx or Doxygen or something else which can programmatically produce doc from the source code.