Merge pull request #101 from Francesco-Lanciana/about-api-quickstart

Made intro section more generic and concise
thegooddocsproject · Feb 6, 2020 · c68ca67 · c68ca67
2 parents a017207 + 7e95259
commit c68ca67
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/api-quickstart/about-quickstart.md b/api-quickstart/about-quickstart.md
@@ -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