Description
This is a comment on Amazon's documentation (and a host of other places where things are documented). I find the non-linear, hyperlinked documentation a very poor way to document things. The person who is trying to learn about something must constantly follow hyperlinks that may or may not assume prerequisite knowledge. What is needed is a linear document that takes the user through all the information in order, building on previous knowledge. If hyperlinks are included, they should only be used to further explain a concept and make it clear how to get back to the track that the reader is following.
For example, the Amplify documentation might start
- Creation of AWS account tutorial (if you have done this, you can skip to step 2)
- Install Amplify
- Creating a Swift app (Install Xcode, create a project)
- Set up the Amplify-specific things necessary for the App
- Do the necessary updates to Amplify (init, push) etc.
- ...
The above might not be right, but it shows the idea. Rather than taking me to a page like the Getting Started page that has 7 hyperlinks that do not indicate the order, and when I get there I find several more hyperlinks even though there is a "next" link at the bottom. So when I get to the introduction page, do I follow all the links Amplify CLI Amplify Libraries, Amplify Studio, etc (and how deep before I come back to follow the "next" Setup Amplify CLI?