This article reviews how to add different article types to a User Guide and how to add content.
User Guide Article Types
User Guides are comprised of Topic, How-To, and Reference pages.
- Topic: Reviews the features of a product or persona.
- Appears in Guide Contents User Guide tab.
- How-To: Reviews how to use a feature.
- Appears in How-To User Guide tab.
- Reference: Supplemental content such as a glossary or appendix.
- Appears in Reference User Guide tab.
Pages will be organized in the guide by these page types. Changing the page URL will not move pages up or down in the guide.
Any article that contains an Page Type set to Topic, How-To, or Reference will display previous / next navigation links, allowing users to be guided through the User Guide.
While Semi-Private pages are hidden from the navigation bar, they will be discoverable when using the previous / next options in User Guides. This allows users to break up longer pages into shorter articles while hiding the smaller pages from the navigation bar. More details about the Semi-Private restriction can be found within the page restrictions documentation.
Adding Articles to a Guide
Adding a Topic
To add a new Topic to a Guide click the Add New Topic button.
A new page which has been pre-populated with the Topic template will open in the editor. Choose a Page Title and then add details to the Overview and Feature sections.
After clicking Save in the editor, you'll see your new Topic. Note that the Page Type is preselected as Topic since the default Topic template was used.
You can also create a new Topic page by choosing the Topic Page template from the New Page gallery.
Adding a How-To Article
To create a How-To article, click on New Page.
Then choose the How-To template option:
A new page which has been pre-populated with the How-To template will open in our editor. Choose a Page Title and then add details to the Overview, Goal, and What's Next sections.
After clicking Save in the editor, you'll see your new How-To article. Note that the Page Type is set to How-To since the default How-To template was used.
Adding a Reference Article
To create a Reference article, click on New Page.
Then choose the Reference template option.
A new page which has been pre-populated with the Reference template will open in the editor. Choose a Page Title and then add to the Overview and Details sections.
The Reference template includes several areas to add Details, Definitions, code snippets, and examples.
After clicking Save in the editor, you'll see your new Reference article. Note that the Page Type is preselected as Reference since the default How-To template was used.