Explanations

The content on this page has not been finalized. Contributors can mark a page as complete and remove this warning by adding status: published to the front matter in the Markdown source file.

The Documentation Method defines four main types of documentation:

  • Tutorials help readers learn how to use a system
  • How To Guides show readers how to accomplish a specific task
  • Explanations help readers understanding a part of the system
  • Reference Guides provide technical documentation about functions, classes, and fields used by the system