This is part 2 in a series of posts in which I air my gripes and grievances (and complements!) about various kinds of software development training and reference materials.
This post is all about the official documentation and reference materials for languages, frameworks, tools, etc.
To be honest, I don’t have much negative to say here. Most of the official documentation I encounter is high quality stuff that I find myself relying on more and more.
My purpose in this post is not to complain, but to make an observation. The purpose of reference docs is to inform, which is not the same as to teach. It exists to inform you of all the things the language/framework/tool can do, but in most cases it has no interest in showing you how to use it in an application. I hesitate to call this a problem because teaching is not the point of reference docs.
Now, if you are a seasoned developer, this will not be a problem. You should be able to read through a page of reference docs and understand how to apply the material to your own projects.
But what if you are not a seasoned dev? In that case, you might have a very hard time teaching yourself from reference documentation. Without enough practical practice, you may not know why a feature is useful, or how a bit of syntax might help you. This highlights how important it is for there to be other kinds of training material beyond reference docs that focuses on how to apply this knowledge.
It also highlights how important it is for this kind of material to be written by experienced people who are not only knowledgeable, but are able to convey taht knowledge to non experts.