DEV Community

Discussion on: How to read a documentation?

Collapse
 
ironicnet profile image
Ezequiel Calderara

Mmm usually this is my approach:

  1. Go to the site and read the getting started, to have an idea of requirements and setup.
  2. Try to really understand what the framework or library does.
  3. Try to do the same setup or have the same requirements.
  4. Look through the tutorials until I find something similar that I want to achieve. I Try that.
  5. If it worked, I try to understand why it worked.
  6. Worked or not, I google for alternatives way of doing that. Or pros and cons.
  7. If google has results with some example, I try that. Back to 5.
  8. If it doesn't work and google doesn't give me good results. I try to read the API of the framework or library to see how it can be achieved.

If what you are looking for is because of an error happening:

  1. Read consciously the error message. Usually it says exactly what's happening.
  2. Try to look at the FAQ or Troubleshoot page.
  3. Check versions, requirements and configurations.
  4. Google the exception message.
  5. Google the first line of the stack trace, where it says which component is failing.
  6. Look up for the source code. Search for issues on it.
  7. If you can reproduce it in a small test, submit issue or try to fix it.
  8. Meanwhile, look for an alternative library or framework