DEV Community

Rachel
Rachel

Posted on

13 2

Favorite Examples of Clear, Understandable Documentation?

What guidance exists for writing technical documentation?

What are some of your favorite examples for easy to understand documentation when tackling a new framework, language, or library?

Top comments (14)

Collapse
 
radiomorillo profile image
Stephanie Morillo β€’

Hi Rachel!

I compiled a list of technical writing resources; you'll find books, courses, and links to documentation style guides from GitLab, DigitalOcean, Google, and Microsoft. Hope this helps!

Collapse
 
supermario_ai profile image
SuperMario β€’

Dope! Thanks for upping that to GH! πŸ’―β€βœŒ

Collapse
 
hugoliconv profile image
Hugo β€’

Thanks!

Collapse
 
agtoever profile image
agtoever β€’

I really like the documentation of the Python library scikit-learn. It’s structure provides an accessible section for newcomers with introductions, tutorials ad examples. But also the class-by-class documentation contains lots of details, usefull cross references, etc.

Collapse
 
madza profile image
Madza β€’

Check out Laravel and Vue docs :)

Collapse
 
nomade55 profile image
Lucas G. Terracino β€’

Laravel design is always of such a good taste.

Collapse
 
markerikson profile image
Mark Erikson β€’ β€’ Edited

I've been working on rewriting the Redux core docs, and collected some notes and resource links on good docs writing practices.

I particularly liked the article What Nobody Tells You About Documentation.

On that note, I just published a brand new "Redux Essentials" tutorial that was written using the lessons I'd learned from those resources.

Collapse
 
terabytetiger profile image
Tyler V. (he/him) β€’

The Vue Docs are SO GOOD πŸ’š

Collapse
 
michelemauro profile image
michelemauro β€’

Spring Boot and Spring Framework documentation sites are terse, easy to read, as detailed as they can be and well styled. All the corpus says "professionally organized" and "well-thought". That's not easy, given all the functionality that both products cover.

Collapse
 
bobbyiliev profile image
Bobby Iliev β€’

The best documentation that I've seen is the DigitalOcean API documentation.

For a small opensource project I believe that Laravel Voyager has some great docs as well.

Collapse
 
daveparr profile image
Dave Parr β€’ β€’ Edited

The tidyverse documentation is phenomenal.

In R we have a few conventions for documentation, which includes both short form (per function) documentation, but also long form (vignettes). Because we also have R markdown these are both driven by the language itself.

In addition we also have packagedown, which turns docs into websites, though I'm sure this exists in python in a similar form as well.

Collapse
 
mellen profile image
Matt Ellen-Tsivintzeli β€’

I haven't read it in a long time (for reasons) but back in the early 2000s the PHP documentation was amazing.

Each function had a clear explanation with clear examples plus user contributions for edge cases.

I haven't found easier to understand documentation since.

Collapse
 
mellen profile image
Matt Ellen-Tsivintzeli β€’

Actually, if I can broaden the definition of documentation, Gatherer, the Magic: the Gathering card index, is pretty great.

Collapse
 
supermario_ai profile image
SuperMario β€’ β€’ Edited

I can tell you that whoever writes NordVPN's copy for their release/patch notes deserves a raise:

nordvpn.com/blog/nordvpn-windows-r...

IMO, a perfect blend of technical and plain talk.

+1 for the Vue specialization!

πŸ’―β€βœŒ

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs