1. Home
  2. Style Guide
  3. Pack Guide | Style Guide Basics

Pack Guide | Style Guide Basics

The following instructions are the basic instructions for creating a knowledge base article using WordPress.

WordPress Login

To start, login to the Pack Guide WordPress Website 

  • Navigate to the WordPress Pack Guide Login Page: https://pack.guide/wp-login.php
  • Login using your Username and Password
  • Click on the Heroic KB on the left side menu
  • Click Add New Article, to add a new article

WordPress Settings

By clicking on the gear icon in the upper right hand corner of your WordPress article, you can turn on and off your settings. It is best to keep this open as it will be useful in setting your Article and Block criteria.

For any article that is meant to remain public facing, use the Public setting under the Visibility option within the Status & visibility settings.

For any article that is meant to remain private, use the Private setting under the Visibility option within the Status & visibility settings. Use of the Private setting allows only site admins and editors to view and edit the article.

For any article that is meant to be internal to the IT Department, use the Password Protected setting under the Visibility option within the Status & visibility settings. Use of the Password Protected setting allows only those with the password to view the post. Those with viewing access cannot edit the page.

The Title

In the Add title section of your new article, type in the title of your page. The title of your page should use the most concise wording possible. It should contain the overall subject of the article. The example for this article is used above, “Pack Guide | Style Guide“. This will appear as the page name when a user searches the site for articles related to their inquiry.

The Description

The description must be typed in under the title in the area where it says, “Type / to choose a block” (See picture above). It should contain a one sentence description as to what the article will discuss. The example for this article is used above, “The following instructions are the basic instructions for creating a knowledge base article using WordPress.

Below is an example of a user searching for Blackboard help. In the How can we Help? search option they entered a general word. All articles containing that word will populate under their search as well as the descriptions for each article explaining what will be discussed within that article. Users can click on any article they see populate or can continue to type more descriptive terms into the search to help narrow down the list of populated articles.

Headings

To add a heading within an article, click on the Add block icon and select Heading.

All headings below the page title should use the H2 formatting. If there is more than one heading in an article, each should use the H2 formatting (as seen in this article). By using the H2 formatting, the user will be able to easily navigate the article by clicking on the headings listed on the left side of the article below the word Contents as seen in the picture below.

Content

The content of your article can be informative or directional, sometimes both.

Informative articles consist of information regarding a particular topic with little to no directions as to its use.

Directional articles consist of directions that lead a user to achieve a particular goal, such as logging in or navigation a system.

This article uses both informative and directional content.

When using informative content, try to be as concise as possible and cover the subject matter clearly. Screenshots and other examples can be used to illustrate a point when needed, but be careful not to use too many.

When using directional content, use the formatting described within this paragraph. Directional content should be in the form of a list. For this article we have chosen to use bullet points, as seen in the Logging In section of this article. Each verb used in the directions should use the italics formatting. This is to draw attention to the action needing to be performed. Bold formatting should be used for any word that describes what the verb is acting upon.

Example: …click on the Add block icon and select Heading.

Heroic Block Messages

Specific to WordPress are items called Heroic Block Messages. These messages are used to point out information that notifies the user of a: Success; Alert; Danger; or Information. These blocks can be found under the Add block icon. If their icon does not appear you can search for the block in the search area.

An example of each and their use are listed below.

Success! You have successfully logged into your account!

Alert! The website is currently under maintenance. Be aware that some items may not be working as designed.

Danger! Giving out your username and password for any account to another person is dangerous and can compromise your information.

Your login credentials for your CSUP email account are as follows:
Username: NetID@colostate.edu
Password: NetID password

Do not stack more than one Heroic Block Message at a time within an article (as seen above). Outside of the example seen above, too many messages can cause confusion for the reader and distracts from the content.

Videos

Videos are very helpful tools to use when showing a user a walkthrough of a particular set of instructions. Videos should always be located at the beginning of an article, if used, so that a user can choose to either watch the video or continue on with reading the text.

Images

When using images to illustrate a point or provide as an example, crop the image to best show the most important part of the image. Do not use full screen pictures as they are too big and hard to see on smaller screens.

Select the image and click on the Alt text (alternative text) on the right side menu to describe the purpose of the image. Leave alternative text empty if the image is purely decorative.

Setting Article Categories

Article categories in WordPress are used to sort and group your blog posts into different sections. To create new categories, click on the Add New Article Category under Article tab in your Settings menu.

Categories should be set up prior to an article’s creation. However, if a new subject matter is needed, a new category can be created to create a new section for articles related to that new subject matter. Otherwise, once an article has been created, the author needs to select no more than one category that the article will fall under before they publish the article.

Updated on September 18, 2023

Was this article helpful?