CommCare Help Site Design Guidance

General Design Guidance

Below are some general design guidelines for maintaining the look of the CommCare Help Site.

Page Structure

Avoid Child Pages

In an effort to streamline the user experience and improve search-ability, please avoid child pages. Instead, you can make longer pages easier to navigate by using tools such as the https://confluence.atlassian.com/doc/expand-macro-223222352.html .

Associated Software Plans

Ensuring that all pages with features that refer to software plans are audited and have the most up to date software plan. Use the below for this.

Table of Contents

In order to see information in a page, please ensure that your pages have a Table of Contents at the top. This requires using headers in formatting.

(Occasionally) Use of Excerpts at the top

To automatically reference the topic of Child Pages in parent pages, we use the Excerpt Macro. You will see this throughout pages: https://confluence.atlassian.com/doc/excerpt-macro-148062.html

Page Design

Referenced links

Please reference Confluence links like this by copying them directly in , not hyperlinked text. This prevents links from breaking. If an external page does not pop up as a referenced link, you can use the hyperlink text as backup.

Consistent Spacing & Bullet Points

Overall the site should maintain a clean look with consistent spacing and bullet points.

“Skinny” pages for readability

To change this, you can select the button to the top right

Site-Wide Multi-Excerpts

Confluence supports a macro called that allows you to reference source information, copy it into different places, and automatically update all information by updates the source.

The below are referenced throughout the CommCare Help Site. When using them, please copy the “Copy into Pages” version.

Software Plan Multi-Excerpts

Standard

Original (Don’t Touch)

Copy Into Pages

Pro Plan

Original (Don’t Touch)

Referenced (Copy this in Pages)

Advanced Plan

Original (Don’t Touch)

This feature requires a CommCare Software Plan

This feature is only available to CommCare users with an Advanced Plan or above. For more details, please see the CommCare Pricing Overview.

Referenced (Copy this in Pages)

Enterprise Software Plan

Original (Don’t Touch)

This feature is only available to Enterprise Partners

Learn more about the CommCare Enterprise offering here: https://dimagi.com/commcare-enterprise/

Referenced (Copy this in Pages)

Other Multi-Excerpts

Community of Practice

Original (Don’t Touch)

Referenced (Copy this in Pages)

Requires Professional Services

Original (Don’t Touch)

Referenced (Copy this in Pages)

Up to Date Version

Original (Don’t Touch)

Referenced (Copy this in Pages)

Technical Instructions

Original (Don’t Touch)