DEV Community

loading...

Discussion on: Where should you put the documentation?

Collapse
robotsquidward profile image
A.J. Kueterman

After years of creating documentation sites, managing wikis, and writing READMEs, I absolutely agree that documentation should live with code. We have started exporting documentation from our Kotlin codebase with Dokka, which encourages good Javadoc style code comments that help you set some context for what your app/library is doing.

So I say:

  • README for project/repo/library overview, and hopefully a tool like GitHub for hosting it for everyone
  • Javadoc-style comments in the code to set context for what is happening here in the code, just a little bump to your (hopefully) self-documenting code