CommCare Help Site Design Guidance
- Gillian Javetski
- Krinda Wernicke
- 1 General Design Guidance
- 1.1 Page Structure
- 1.2 Page Design
- 2 Site-Wide Multi-Excerpts
- 2.1 Software Plan Multi-Excerpts
- 2.1.1 Standard
- 2.1.2 Pro Plan
- 2.1.3 Advanced Plan
- 2.1.4 Enterprise Software Plan
- 2.2 Support Types
- 2.3 Technical Alerts
- 2.3.1 Up to Date Version
- 2.3.2 Technical Instructions
- 2.1 Software Plan Multi-Excerpts
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 CommCare Help Site Design Guidance | Software Plans 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 CommCare Messaging , 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 MultiExcerpt | Atlassian Marketplace 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)