Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Made intro section more generic and concise
Browse files Browse the repository at this point in the history
The intented results is a little vague. I think the intended result is for the user to experience your product working, so I tried to word it more that way.

I think the second point now captures what I deleted regarding making the benefits of your product apparent to the user (not just telling them, but showing them).

Attempts to address Issue #37
  • Loading branch information
Francesco-Lanciana committed Jan 17, 2020
1 parent 4d9e0d9 commit 7e95259
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions api-quickstart/about-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## What is a Quickstart

* It should be a clear, concise, step-by-step procedure. (A set of numbered steps.)
* It should describe the easiest way to get the intended results from the API, as opposed to the most optimized production modes or the most advanced uses of the API. Another way to describe a quickstart is that it shows potential users what your API can do, rather than tell them; if they follow the steps, any benefits (and the ease of obtaining them) ought to be apparent.
* It should be a clear, concise, ordered step-by-step procedure.
* It should describe the easiest way for them to achieve a result that shows off the capabilities of your product.
* It should not delve into optimizations or advanced use cases.

## Contents of Your Quickstart

Expand Down

0 comments on commit 7e95259

Please sign in to comment.