Remove Design/Architectural information from Getting Started documentation

Narrow the scope of the “Getting Started” page to helping new users use QC’s basic features.

Make this an introductory page. Assume your target audience has no knowledge of QC; “Explain it like I’m 5 years old”
Structure the document as a tutorial
Introduce one feature per section
Consistently present steps as code snippets whenever possible
Include hyper links to documentation where appropriate
Remove all design and architectural information
Remove all references to classes/components/data that are not directly required to implement the basic feature being tutored
Make the file name and page title the same, either quickstart or “getting started”. These two terms have subtly different connotations

‌

Comments (2)