proofofconcept icon indicating copy to clipboard operation
proofofconcept copied to clipboard

User and developer input needed on specific tutorials/guides/references/explanations

Open bhpayne opened this issue 4 years ago • 0 comments

What topics need to be documented in tutorials/guides/references/explanations?

  • Tutorials: Lessons that take the reader by the hand through a series of steps to complete a projects (or meaningful exercise). Geared towards the users learning.
  • How-To Guides: Guides that take the reader through the steps required to solve a common problem (problem-oriented recipes).
  • References: Explanations that clarify and illuminate a particular topic. Geared towards understanding.
  • Explanations: Technical descriptions of the machinery and how to operate it (key classes, functions, APIs, and so forth). Think Encyclopedia article.

bhpayne avatar Aug 16 '20 14:08 bhpayne