Question Locked

Am I the only one that finds it difficult to follow documentations?

0 helpful
4 replies
Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.

I have been learning some new tools and frameworks lately, and I honestly struggle with reading official documentation. Sometimes it feels like it assumes I already know a lot, or it just jumps straight into advanced stuff without breaking it down.

Am I the only one who feels this way?
How did you get better at understanding documentation?
Any tips or methods that helped you make sense of it over time?
[hr]
Sorry, if this appears twice. I posted it yesterday but I can't see it anywhere on my timeline. Are posts approved manually?

4 replies

by birdmantd

Honestly, most documentation like you mention is written by engineers for engineers and not outside users, hence the difficulty for the average reader.

Back to your second question, posts normally don't need approval, but if a moderator feels that a post is advertising or SPAM, it may be deleted without notice as per the forum rules.

by chrisjordanmf edited

You're definitely not the only one, Techjuju — I’ve had the same experience with documentation, especially when learning new frameworks. A lot of it feels like it's written for people who already know the tool inside out.

What helped me was combining the docs with beginner-friendly resources., like a tutorial or a helpful video.
That gave me the context I needed so the official docs started to actually make sense.

One tip: treat documentation more like a reference than a learning guide. I stopped trying to read it all at once and started looking things up as I needed them. Over time, it becomes easier to follow.

And don’t worry — your post is thoughtful and relatable. Glad you shared it. You’re not alone in this! 👊

by rproffitt edited

1. Make it simpler. Build up from some beginning base of understanding. Complaints that we waste their time.
2. Start from a higher level. Complaints that we didn't detail the basics such as "what is a variable?"

For me this as a writer at times for tech documentation.
Best you can do is to find primers for the new tools and frameworks.

by Techjuju edited

It seems that I have gotten a great tip from you. I have not tried it, but it sounds like something that will definitely work.
[quote]"One tip: treat documentation more like a reference than a learning guide. I stopped trying to read it all at once and started looking things up as I needed them. Over time, it becomes easier to follow."[/quote]
I always have greater difficulty reading the whole documentation. Right now, I have to see it as a reference book rather than a total guide.

This discussion is closed to new replies.