Microshare™ Documentation Model Page

Serves as a reference that all other pages should model

Summary

The page should always open with a outline of what the page entails, no matter the size of the page. This makes navigation much smoother and decreases the time between getting that answer to the user.

General Formatting

Each section should be titled in header 2 (This is ## in markdown). Each section should have a line break before the section header to visually show the end of the previous topic. The line break should appear directly under the last line of the section, no spatial break in between.

Sub Section

If the section has a sub section, make sure to give the sub section a title in header 3(This is ### in markdown).

Bulleted versus Numbered Lists

A numbered list should be used for:
1. There are steps and the user needs to follow the information in a direct manner.
2. The numbered list should be bolded with line breaks in between for aesthetic purposes.

A bullet point list should be used if:
The information given does not follow a strict order of instruction and the information is more free flowing.
You can use a * or a - in markdown to signify a bullet point.
- If the list has lots of nested points

Both styles of lists should include a period at the end of the sentence.

Sections should be numbered or bulleted similarly. If the order of the sections is critical like a roadmap, then the sections should be numbered. Else if the section topics can be jumped between each other, the sections do not need to be numbered.

Other Standards

Microshare™ should be used in the title of the page only and refer to Microshare in the body of the documentation.

emails or objects should be given in this form.

All links should be easily followed.

Mentioned sections should be linked.

model page 1

{
  "All JSON": "Should be given in this format",

},

All Spreadsheets	Should be given
In this format	using an online converter