DEV Community

Tyrese Williams
Tyrese Williams

Posted on

How to read Documentation

Want to scan through documentation like a WARRIOR By the end of this blissfully perusal you as a (developer, crypto nomad, designer) will be able to read documentation for the subjects of your interest in 2020?

"Most documentation says 'Get started' "

This is software. Exploitable software. Software needs maintenance, surgery, tools, equipment or it will rot by giving it no attention. This is obvious. Regarding (developer person), reading documentation is similar to stepping in a arena. Preparation is necessary.

1. ๐Ÿ”จYou as a developer, using licensed software should be thinking.

  • "Does this software support my system?" ๐Ÿค”
  • "What requirements do I need to get started?" ๐Ÿค”
  • "I'm new. How do I get started?" ๐Ÿค”
  • "What are some examples?" ๐Ÿค”
  • "Who (companies) are using this software?" ๐Ÿค”
  • "Will this documentation help me get started?"
  • 2. Prepare to be presented Examples๐Ÿ““

    Expect to be presented multiple or single quick illustrative example(s) to quickly get you as a developer up and running with the new software your interested in.

    3. Prepare to be presented Instructions๐Ÿ““

    Expect to be presented a list of orders from command HQ to run the necessary software your interested in.

    4. Prepare to ask for more resources๐Ÿ““

    Expect to ask for more resources or be willing to browse the web, think harder to find more resources

    Reading documentation isn't a breeze. Starting to scroll the documentation page of a new technology without precautions is the same as allowing a leaf to fall from a tree and watch the leaf slowly descend to the ground allowing thirty minutes of what could've been productive time reading documentation to pass silently.

    It's also worth to know that silently the software documentation your attempting to read and recall is being used by (as many companies it says it's being used by on GitHub). It's obvious how to understand the software

Top comments (0)