DEV Community

Savvas Stephanides
Savvas Stephanides

Posted on

What is something library docs do that make it difficult to follow for newbie developers?

In your opinion, when newbie developers read docs, what is the most frustrating part?

I've asked this question on Twitter yesterday and got a few responses:

lack of examples! I skim thru when i view any docs.. if it doesn't have examples, i struggle a bit at first πŸ˜…

-- @CuriouZmystee

Not having working example code or obsolete code that doesn't work and or compile.

-- @tswain555

Jargon and term standardization is always a killer.

Hot take: add a synonym guide in the back of all documentation.

-- @Quasicodo

What would you add? What has been your experience?

Top comments (0)