Section Guide

As each help doc has a primary purpose, a doc's section will refer to the primary technology required to carry out that purpose. Sections help keep help docs organized and enable searching by base technologies that allow you to target specific technologies. Check out the Sections Rules below for more information of how sections are implemented in help docs.

Section Rules

Every Help Doc Will Have 1 Section

Every help doc should have a singular purpose that deals with a primary technology which will be indicated by its section.

A Help Doc's Section Should Be Inferable

Because every help doc should have a single purpose, the section for the doc should be able to be logically determined from the doc's content. In cases where a help doc's section cannot be logically inferred, that is a strong indicator that the help doc's purpose is not well defined and most likely should be broken up into multiple docs.

A Help Doc's Section Should Be General

Because help docs are intended to be filtered by technologies, overly restrictive sections would increase the difficulty of finding the intended documents. To facilitate searching, sections should refer to the base technology used where more specific details are delegated to tags. Check out the Tagging Rules Section for more information on tagging.