WordPress: Write Documentation via WordPress Help Plug-in


This training will help introduce you to and familiarize yourself with the WP Help plugin, a helpful resource for organizing internal documentation on WordPress. This will be helpful should you ever need to help manage the STA blog or help guide clients with setting up documentation on their WordPress sites.

What is the WP Help plugin?

The WP Help plugin is downloaded across UT WordPress sites so that WordPress administrators can easily and fluidly add, edit, and organize documentation housed within the WordPress site. This enables there to be a steady library of help, easing difficulty of web administration handoff. 

How do I access this plugin?

The WP Help is accessible from the WP homepage, visible on the left side of the dashboard. I’m using the STA blog as an example, but this is consistent across WordPress sites, including those created for client use. 

The information on the WP Help page can also be viewed on the dashboard.

First, click on “Publishing Help”. You should now see this page appear. 

As you can see, help topics titles begin with the relevant role that might want to complete this given task. This means that whoever is viewing the WP Help page can quickly and easily focus on the tasks relevant to them (STA or STA manager). Please note that these are not absolute: occasionally an STA might complete tasks usually delegated to a manager, such as inviting a new STA to the blog. However, they are a great guide for those simply glancing at the plugin. 

To reorder the documentation, simply use the icons to the left of each hyperlinked entry to drag and drop.

When you select one of the help topics, the entry will appear beside the navigation bar. You may click the “edit” link to make any changes or updates to the documentation. Alternatively you may select the “manage” button above the list of help topics to either edit or “quick edit” any documentation. Additionally, you can delete any documentation using this method.

To create any new documentation, select “add new,” and you will be navigated to an editor similar to that of creating a new post. If this is for the STA blog, start the title with the relevant role. 

Use the “Parent” dropdown to select a documentation if this is building off another topic (for example, if there’s an additional topic related to adding posts & images in posts). Otherwise, it’s perfectly fine if it has no parent!

When you’re done, simply click publish for it to appear as an entry. You can always edit it later.

This entry was posted in Misc. Bookmark the permalink.

Comments are closed.