⚡ As a developer, what is your pet peeve in API documentation?

Missing examples? Outdated guides? Vague error messages? :eyes:

We’ve all been there.

:speech_balloon: Share the one thing that instantly frustrates you in technical documentations.

6 Likes

when a date/time field is required but the proper accepted format is not stated :thinking:

8 Likes

a README.md with title only

5 Likes

Outdated API docs

7 Likes

API request examples are left as an exercise for the reader :face_with_spiral_eyes:

4 Likes

Improper markdown formatting (e.g. code block containing JSON but left as generic)

4 Likes

Broken links

8 Likes

vague or misleading error handling. only seeing generic errors.

5 Likes

When there are too much emojis

4 Likes

No table of contents. Too much information is hard to digest and a table of contents helps me quickly find what I need.

7 Likes

When you have seen the information in the docs before but can’t find it again

5 Likes