DEV Community

Discussion on: What are some examples of great documentation?

Collapse
 
pavonz profile image
Andrea Pavoni

Maybe the best examples I've seen are Go and Elixir.

In Elixir, you cam write the main documentation for a module, for each public function and... write examples that can be run as real tests! They are, indeed, called "doctest" elixir-lang.org/getting-started/mi...

Golang has an excellent documentation system: it lets you edit/run the code in examples.

I've mentioned documentation systems rather than specific projects docs. Well, sometimes is the doc system that incentivizes writing docs. That's why Elixir, Golang and many other technologies usually have good documentation.

My 2cents