How to Write a Help Article for WordPress

How to Write a Help Article for WordPress

This article is aimed at Nuttify Squirrels and takes you through how to write a help article. We’ve made it public because some people may find it useful to read about how we produce readable help articles to help our website customers.

Important Things to Note

  • All help articles are listed on the Help Articles page
  • Articles that have their audience tagged as “nuttify” are only visible to Nuttify super admins
  • Help articles can be tagged, and put into topics (categorised).
  • Help articles can be hierarchical – have parent and child articles. This can help us group them into chapters.

How to Add a New Help Article

Only editors and administrators can create help articles. To start, make sure that you are logged in (well you would be if you are reading this, wouldn’t you?)

  1. From the Dashboard select Help Articles > Add Help Article
  2. Create a descriptive title for your help article, like “How to Write a Help  Article
  3. Type in your instructions in the main body area of the post.
  4. To restrict your article for Nuttify admin staff write “nuttify” in the “Audience” section in the right hand column (This is a handy feature and if you need a function like this, then please contact us)
  5. If you want to tag the article as relevant to a particular process or  system, add this as a tag under “Help Topics

Styling guidelines

We are Champion WordPress Website Developers

Where ever practical use the words “WordPress Website developer” as in “Ask your friendly Nuttify Champion WordPress website developer to help you out with this….”, or “Nuttify are the web developers that you’ll love, because we help you meet your business goals”, or “Nuttify are one of the few WordPress web developers around who care about you meeting your business goals which is why we…..”

eCommerce Help Articles

Where possible, please refrain from using the word “WooCommerce” and use “eCommerce Website”. Include the words eCommerce website in:

  • The title
  • The slug
  • The copy
  • Images file name, alt tag,description,title and caption if applicable

Links

Use links on keywords to relevant sales pages, help articles and blog posts.
Refrain from linking on words such as “this article” or “here”. This is bad for SEO and user experience.

Headings

Titles of articles and headings within articles should use capitals for every word – because is is easier to read. For example:

Incorrect:

How to write a help article

Correct:

How to Write a Help Article

Bullet Lists

We rely heavily upon ordered bullet lists in our help articles. This helps users follow a sequence of steps. There are a couple of tricks that enable us to create nicely bulleted lists with embedded images. This involves a bit of raw HTML manipulation, but gives a great result.

For example, to create a list with images we use the following approach:

  1. Click on the ordered list button in the TinyMCE editor bar at the top of the main content editing area, and add your first instruction.
  2. To insert an image into the list item do a “Shift + Enter” to create a non-breaking new line. Then click “Add media ” and upload the image – which is likely to be a screen shot:

    A screen shot inserted into a list item

    A screen shot inserted into a list item

  3. You might need to go into “Text” view to tidy up the HTML
  4. Also it is a good idea to give the image a relevant and descriptive title, alt tag and caption.
  5. You can also add H2 and H3 elements within List items

    Best to go into the HTML and manually add <h2> and <h3>tags. Like in this example:

    For example, to create a list with images we use the following approach:

Inserting code into a help article

Code is inserted into help articles using the Canyon plugin. When you want to add a code snippet – whether that is CSS, HTML PHP, or any other language we might be using do the following:

  1. Paste in the code into the editor and select it , or
  2. Click the canyon button in the editor – it looks like two opening and closing brackets <> and paste in the code 
  3. Set the code sing the drop down – if necessary – say to “PHP” or “CSS”.
  4. Click “Add

Canyon code editor

Like what you see?

Find out how we can build a champion website for you.

Call Nuttify today 1300 688 4391300 688 439
or send us a message
No comments yet.

Leave a Reply