Missing examples? Outdated guides? Vague error messages? ![]()
We’ve all been there.
Share the one thing that instantly frustrates you in technical documentations.
Missing examples? Outdated guides? Vague error messages? ![]()
We’ve all been there.
Share the one thing that instantly frustrates you in technical documentations.
when a date/time field is required but the proper accepted format is not stated ![]()
a README.md with title only
Outdated API docs
API request examples are left as an exercise for the reader ![]()
Improper markdown formatting (e.g. code block containing JSON but left as generic)
Broken links
vague or misleading error handling. only seeing generic errors.
When there are too much emojis
No table of contents. Too much information is hard to digest and a table of contents helps me quickly find what I need.
When you have seen the information in the docs before but can’t find it again