[ragnarkon]

If the audience is other developers/engineers (which it sounds like it is)... I like to document the code within the code itself and use automation to generate that documentation. If it fails to generate or documentation is missing, the pipeline itself will fail and prompt the developer to write docs before it gets merged.

I'm usually programming in Ruby or Golang. For Ruby my tool of choice is the Yard gem... and for Golang it would be GoDoc (built into Go itself). But most languages have their own equivalent tools.

If the audience is business folks and not developers... oofffpppph.