How to create a help guide

Last updated on November 1, 2021 at 10:44 am
Learn how to create a help guide in CMS help center.
This article is for:
CMS Knowledge Base

Before you start

You need the Content admin role or higher.

Create the help guide

  1. In the top toolbar menu, click Manage.
  2. Hover over Content, hover over Add content, then click CMS Knowledge Base article.
  3. In the Page title field, enter the action the user will be able to perform after reading the guide.
  4. Choose what CMS-supported Products your KB article relates to. Most articles relate to only one product, but some articles to multiple products. There's also an "All products" option, for basic KB articles. 
  5. In the Page introduction field, enter a brief statement about what the user will learn about in the guide.
  6. Click Add content block.
  7. Find the Rich text block and click Add.
  8. In the Text field, enter a heading. Highlight the heading text and click Format in the rich text menu to select Heading 2.
  9. Enter the steps. Click the bulleted list icon in the rich text menu to format the steps.
  10. If you want to add an image, click Add content block, scroll down to the Embedded image block type, and click Add. Follow the content block inline instructions.
  11. On the right under Menu Settings, enter the Page Title in the Menu link title field. If your Page Title is long, use a shorter version in the Menu link title field.
  12. Click the Parent item dropdown menu and select your product.
  13. Click the Section dropdown menu and scroll down the list to select VA.gov CMS Help Center.
  14. Under Related User Guides, in each line start to enter a topic for a related guide.
  15. From the list of suggested matches, click to select the guide you want.
  16. If you have multiple related guides, click the Order dropdown menu to change the order.
  17. Scroll down to Editorial workflow.
  18. Click Save as and select a moderation state.
  19. Enter a Revision log message.
  20. Click Save.

 

Insert the link into the product (VAMC, Vet Centers, etc.) help guides page

  1. In the top toolbar menu, click Manage.
  2. Click Content.
  3. In the Title field, enter the title of the product help guides page.
  4. Click Filter.
  5. In the results list, find the page and click Edit.
  6. Under Main Content, find the list of links that you need to edit and click Edit.
  7. In an empty URL field, start to enter the title of the guide you just created and select it from the list of suggested matches.
  8. In the Link text field, enter the brief text that tells Veterans where the link will go.
  9. If you need to change the order of links, click the arrows icon and drag it up or down or use the Order dropdown menu to select the row weight.
  10. Scroll down to Editorial workflow.
  11. Click Save as and select a moderation state.
  12. Enter a Revision log message.
  13. Click Save.

Was this helpful?