Knowledge Article Standards

Intended Audience: Internal Knowledge Base Users

This article is intended for Knowledge Base Technicians, Approvers, and Administrators. 

Article Structure and Header Usage

All articles should be divided into a consistent and understandable structure using headers.

Headers should be used in an ascending order, starting with the usage of second level headers:

  • Header 2 - Section Title
    • H3 - Header 3 - Subsection
    • H3 - Header 3 - Subsection
    • H3 - Header 3 - Subsection
  • H2 - Header 2 - Section Title
    • H3 - Header 3 - Subsection
    • H3 - Header 3 - Subsection
    • H3 - Header 3 - Subsection

All articles will, by default, have the article title in a Header 1 format. No other Header 1 (H1) headers should be used in the article.

All headers should use the Fire Brick color option. H1 formatted headers are to be black, as dictated by a default setting.

Headers should be content and driven and should be used to divide the article into sections, as done so in this article's structure:

  • H2 - Article Structure and Header Usage
  • H2 - Required Article Content
    • H3 - Intended Audience Disclosures
    • H3 - Article Summaries
    • H3 - Article Tags

Required Article Content

To maintain consistency in the Business Affairs Knowledge Base, all articles, internal or otherwise, should employ an approved template.

If an article does not match the nature of any template, the article will be required to the Base Template.

Intended Audience Disclosures

As present in all templates, all articles are required to disclose the Intended Audience. The intended audience are the individuals who would be best served by the contents of the article in question. Articles may be public to more individuals than those in the intended audience. As such, please do your best to link any related articles that would better serve individuals whom the article is not intended for.

Article Summaries

Every article is required to have a 1-2 line summary statement entered into the Articles Summary section.

This statement will appear on the category's listing of the article, and in any areas in which the article is provided through a shortcut.

Article Tags

Every article is required to at least enter the title of the article as an article tag.

The tag should be hyphenated. For example:

  • Knowledge Article Policies and Style Guide -> knowledge-article-policies-and-style-guide

Related Articles / Related Services

Every article is required to list all articles and services related to that article. If an article has no related articles or services, a related service or article does not need to be provided.

Files

All attached files should pertain to the article and should meet accessibility standards for that document type.

Videos & External Content

Any external media embedded within the Knowledge Base should be owned by a shared department account. Videos and other external media embedded in the Knowledge Base should be separate from an employee's personnel or individual work email address.

As with files, all external content embedded within the Knowledge Base should meet accessibility standards for that document type, as defined by the Office of Accessibility. 

Specifically, captions must be provided for all videos embedded on the Knowledge Base. Automated captions most likely do not meet accessibility standards. Departments must make reasonable effort to ensure that captions are reflective of the video's content and are accessible. For additional video standards and for accessibility recommendations, please visit the Office of Accessibility's website.

Transcripts must be provided for audio-only content embedded on the Knowledge Base.

Writing Styles, Accessibility, and Voice

Writing Styles and Voice

All guides are required to follow the UNLV Editorial Guide, the Associated Press Stylebook, and Libel Manual (AP Stylebook), and the UNLV Web Writing Guidelines, unless specifically stated otherwise.

Accessibility

All Knowledge Base Articles and all external content should meet basic accessibility standards. Please utilize the Office of Accessibility's resources in creating and editing accessible articles.

Details

Article ID: 1321
Created
Mon 6/12/23 7:36 AM
Modified
Thu 11/2/23 12:32 PM

Related Articles (1)

Welcome to the BA Support Portal Knowledge Base! Interested in hosting your department's knowledge here? Read this article to get started.