---

Documentation

Docs High Level Design

This template is based heavily on What nobody tells you about documentation. In docsSrc folder you'll see a similar structure to what is described below:

• Tutorials
  • is learning-oriented
  • allows the newcomer to get started
  • is a lesson
  • Analogy: teaching a small child how to cook
• How-To Guides
  • is goal-oriented
  • shows how to solve a specific problem
  • is a series of steps
  • Analogy: a recipe in a cookery book
• Explanation
  • is understanding-oriented
  • explains
  • provides background and context
  • Analogy: an article on culinary social history
• Reference
  • is information-oriented
  • describes the machinery
  • is accurate and complete
  • Analogy: a reference encyclopedia article

The folders in docsSrc are:

• content - custom css, javascript, and similar go here.
• Explanations - A content section as defined above.
• img - extra files like screenshots, images, videos.
• How-To-Guides - A content section as defined above.
• Tutorials - A content section as defined above.
• index.md - The entry page to your documentation

The navbar is generated by the category specified in each front-matter of every content file in docsSrc, excluding content and files folders.

• Api References
• Explanations
• How Tos
• Tutorials

The odd one not generated from the convention of your folders in docsSrc is Api References. This is generated by the XML Doc Comments in your libraries under the src folder.

---

Below is an example homepage. You should start by simply explaining your project in plainest and simplest terms possible.

What is My MyLib.1?

MyLib.1 fixes this one particular set of problems.

Why should I use MyLib.1?

These problems include:

Example Solving Problem 1:

Example Solving Problem 2:

How do I get started

dotnet add nuget MyLib.1

Or follow Tutorial 1

Who are the maintainers of the project

• @MyGithubUsername