Naming Conventions

The title of a KB article should accurately represent the content in a clear and concise way. For example, "Accessing Network Folders" is a much better title than "How to connect to the Shared, My Docs, Netfiles, and Zoo folders".

The title of an article is used to create the URL to the guide. This makes it important to have a well-considered title from the beginning. Renaming an article later will change the URL and may break outside links that refer to the guide.

Style Conventions and Format

• Title of article (as noted in Getting Started.
• Articles should include an introduction to the overarching topic of the guide (if applicable).
• Messages should be used to NOTE important information.
• Use bold text when referencing specific buttons or menus.
• Toggles should be used to separate guides for varying operating systems, devices, or methods.
  • Example: https://www.uvm.edu/it/kb/article/connect-to-uvm-wireless
• Example below:

Step Numbering

Steps should be in a number list format.

1. This is the first step.
2. Then you do this.
3. From here, you should enter this.