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.
Before you start
You need the Content admin role or higher.
Create the help guide
- In the top toolbar menu, click Manage.
- Hover over Content, hover over Add content, then click CMS Knowledge Base article.
- In the Page title field, enter the action the user will be able to perform after reading the guide.
- 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.
- In the Page introduction field, enter a brief statement about what the user will learn about in the guide.
- Click Add content block.
- Find the Rich text block and click Add.
- In the Text field, enter a heading. Highlight the heading text and click Format in the rich text menu to select Heading 2.
- Enter the steps. Click the bulleted list icon in the rich text menu to format the steps.
- 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.
- 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.
- Click the Parent item dropdown menu and select your product.
- Click the Section dropdown menu and scroll down the list to select VA.gov CMS Help Center.
- Under Related User Guides, in each line start to enter a topic for a related guide.
- From the list of suggested matches, click to select the guide you want.
- If you have multiple related guides, click the Order dropdown menu to change the order.
- Scroll down to Editorial workflow.
- Click Save as and select a moderation state.
- Enter a Revision log message.
- Click Save.
Insert the link into the product (VAMC, Vet Centers, etc.) help guides page
- In the top toolbar menu, click Manage.
- Click Content.
- In the Title field, enter the title of the product help guides page.
- Click Filter.
- In the results list, find the page and click Edit.
- Under Main Content, find the list of links that you need to edit and click Edit.
- 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.
- In the Link text field, enter the brief text that tells Veterans where the link will go.
- 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.
- Scroll down to Editorial workflow.
- Click Save as and select a moderation state.
- Enter a Revision log message.
- Click Save.