Skip to content

Commit

Permalink
deploy: medic/cht-docs@7df3d7a
Browse files Browse the repository at this point in the history
  • Loading branch information
medic-ci committed Oct 1, 2024
1 parent 879ea3a commit e55ec44
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions building/guides/training/training-cards-resources/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -314,15 +314,15 @@
<label for=m-contributemediconboardingteam-meetings-check><a href=/contribute/medic/onboarding/team-meetings/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-contributemediconboardingteam-meetings><span>Team Meetings</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-contributemediconboardingdaily-updates-li><input type=checkbox id=m-contributemediconboardingdaily-updates-check>
<label for=m-contributemediconboardingdaily-updates-check><a href=/contribute/medic/onboarding/daily-updates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-contributemediconboardingdaily-updates><span>Daily Updates</span></a></label></li></ul></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-glossary-li><input type=checkbox id=m-glossary-check>
<label for=m-glossary-check><a href=/glossary/ title="Glossary and Definitions" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-glossary><span>Glossary</span></a></label></li></ul></li></ul></nav></div></aside><aside class="d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none"><div class="td-page-meta ml-2 pb-1 pt-2 mb-0"><a href=https://github.com/medic/cht-docs/edit/main/content/en/building/guides/training/training-cards-resources/_index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/medic/cht-docs/issues/new?title=Improve+%27Training%20Cards%20Resources%27&amp;labels=enhancement&amp;body=Page:+/building/guides/training/training-cards-resources/%0aVersion:+2024-09-12%2021:04:47%20+0300%20+0300%0a---" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/medic/cht-core/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a></div><div class=td-toc><nav id=TableOfContents><ul><li><a href=#best-practices>Best practices</a></li><li><a href=#examples>Examples</a><ul><li><a href=#floating-action-button>Floating Action Button</a></li><li><a href=#more-options-menu>More Options Menu</a></li></ul></li></ul></nav></div></aside><main class="col-12 col-md-9 col-xl-8 ps-md-5" role=main><nav aria-label=breadcrumb class=td-breadcrumbs><ol class=breadcrumb><li class=breadcrumb-item><a href=/building/>Building</a></li><li class=breadcrumb-item><a href=/building/guides/>Quick Guides</a></li><li class=breadcrumb-item><a href=/building/guides/training/>Training</a></li><li class="breadcrumb-item active" aria-current=page>Training Cards Resources</li></ol></nav><div class=td-content><h1>Training Cards Resources</h1><div class=lead>Training cards for CHT</div><header class=article-meta></header><h2 id=best-practices>Best practices<a class=td-heading-self-link href=#best-practices aria-label="Heading self-link"></a></h2><p>If you are deploying new training cards, here are some best practices to follow:</p><ul><li>When deploying training cards for the first time, provide guidance in advance as to what users should expect from the cards and how to use them</li><li>Test training card content with a small set of users to ensure learnability and understanding before deploying to your live instance</li><li>Test on a physical device to see what content will look like on different screen sizes</li><li>Keep content to a minimum and try to have as few cards as possible</li><li>Ensure images aren&rsquo;t confused with UI elements: Add outlines or shadows indicating they&rsquo;re for demonstrative purposes only. Never include navigation buttons in your screenshots (e.g., &ldquo;Next&rdquo; or &ldquo;Cancel&rdquo;).</li><li>Make sure users know who to contact if they run into issues</li><li>Establish success criteria for the training cards</li></ul><p>Some examples of data to monitor include:</p><ul><li>Users who have completed the training within X days</li><li>Outliers, ex. users who have seen the cards multiple times and not completed the training</li><li>The intended users have received the training</li></ul><h2 id=examples>Examples<a class=td-heading-self-link href=#examples aria-label="Heading self-link"></a></h2><p>Below is a list of <a href=/building/features/training/>trainings cards</a> that you can use in your project to train users about new updates in CHT. Read the <a href=/building/guides/training/training-cards/>step by step guide</a> to deploy the training cards.</p><h3 id=floating-action-button>Floating Action Button<a class=td-heading-self-link href=#floating-action-button aria-label="Heading self-link"></a></h3><p><em>Introduced in 4.2.0</em></p><p>The additive actions (creating reports, places, people, etc&mldr;) have moved from the bottom action bar to a Floating Action Button. Use this training to introduce the change to your users.</p><p>Get the training card files <a href=https://github.com/medic/cht-docs/tree/main/content/en/building/guides/training/training-cards-resources/available-trainings/floating-action-button>here</a>.</p><figure class="left col-10"><img src=images/floating-action-button.png></figure><br clear=all><h3 id=more-options-menu>More Options Menu<a class=td-heading-self-link href=#more-options-menu aria-label="Heading self-link"></a></h3><p><em>Introduced in 4.2.0</em></p><p>The Edit, Delete and Export actions have been moved to the More Options menu. Use this training to introduce the change to your users.</p><p>Get the training card files <a href=https://github.com/medic/cht-docs/tree/main/content/en/building/guides/training/training-cards-resources/available-trainings/more-options>here</a>.</p><figure class="left col-10"><img src=images/more-options.png></figure><br clear=all><div class=section-index></div><h2 id=related-content>Related Content</h2><div class=section-index><hr class=panel-line><div class=entry><h5><a href=/building/features/training/>Building >
<a href="https://github.com/medic/cht-docs/issues/new?title=Improve+%27Training%20Cards%20Resources%27&amp;labels=enhancement&amp;body=Page:+/building/guides/training/training-cards-resources/%0aVersion:+2024-10-01%2016:38:07%20+0300%20+0300%0a---" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/medic/cht-core/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a></div><div class=td-toc><nav id=TableOfContents><ul><li><a href=#best-practices>Best practices</a></li><li><a href=#examples>Examples</a><ul><li><a href=#floating-action-button>Floating Action Button</a></li><li><a href=#more-options-menu>More Options Menu</a></li></ul></li></ul></nav></div></aside><main class="col-12 col-md-9 col-xl-8 ps-md-5" role=main><nav aria-label=breadcrumb class=td-breadcrumbs><ol class=breadcrumb><li class=breadcrumb-item><a href=/building/>Building</a></li><li class=breadcrumb-item><a href=/building/guides/>Quick Guides</a></li><li class=breadcrumb-item><a href=/building/guides/training/>Training</a></li><li class="breadcrumb-item active" aria-current=page>Training Cards Resources</li></ol></nav><div class=td-content><h1>Training Cards Resources</h1><div class=lead>Training cards for CHT</div><header class=article-meta></header><h2 id=best-practices>Best practices<a class=td-heading-self-link href=#best-practices aria-label="Heading self-link"></a></h2><p>If you are deploying new <a href=/building/features/training/>trainings cards</a>, here are some best practices to follow:</p><ul><li>When deploying training cards for the first time, provide guidance in advance as to what users should expect from the cards and how to use them</li><li>Test training card content with a small set of users to ensure learnability and understanding before deploying to your live instance</li><li>Test on a physical device to see what content will look like on different screen sizes</li><li>Keep content to a minimum and try to have as few cards as possible</li><li>Ensure images aren&rsquo;t confused with UI elements: Add outlines or shadows indicating they&rsquo;re for demonstrative purposes only. Never include navigation buttons in your screenshots (e.g., &ldquo;Next&rdquo; or &ldquo;Cancel&rdquo;).</li><li>Make sure users know who to contact if they run into issues</li><li>Establish success criteria for the training cards</li></ul><p>Some examples of data to monitor include:</p><ul><li>Users who have completed the training within X days</li><li>Outliers, ex. users who have seen the cards multiple times and not completed the training</li><li>The intended users have received the training</li></ul><h2 id=examples>Examples<a class=td-heading-self-link href=#examples aria-label="Heading self-link"></a></h2><p>Below is a list of training cards that you can use in your project to train users about new updates in CHT. Read the <a href=/building/guides/training/training-cards/>step by step guide</a> to deploy the training cards.</p><h3 id=floating-action-button>Floating Action Button<a class=td-heading-self-link href=#floating-action-button aria-label="Heading self-link"></a></h3><p><em>Introduced in 4.2.0</em></p><p>The additive actions (creating reports, places, people, etc&mldr;) have moved from the bottom action bar to a Floating Action Button. Use this training to introduce the change to your users.</p><p>Get the training card files <a href=https://github.com/medic/cht-docs/tree/main/content/en/building/guides/training/training-cards-resources/available-trainings/floating-action-button>here</a>.</p><figure class="left col-10"><img src=images/floating-action-button.png></figure><br clear=all><h3 id=more-options-menu>More Options Menu<a class=td-heading-self-link href=#more-options-menu aria-label="Heading self-link"></a></h3><p><em>Introduced in 4.2.0</em></p><p>The Edit, Delete and Export actions have been moved to the More Options menu. Use this training to introduce the change to your users.</p><p>Get the training card files <a href=https://github.com/medic/cht-docs/tree/main/content/en/building/guides/training/training-cards-resources/available-trainings/more-options>here</a>.</p><figure class="left col-10"><img src=images/more-options.png></figure><br clear=all><p>Once you have downloaded the training card files, follow the <a href=/building/guides/training/training-cards/>step by step guide</a> to learn how to edit the <code>properties file</code> to configure:</p><ul><li>The <code>roles</code> of users who can view the training cards</li><li>The <code>start_date</code> to define the training start day (when the training cards should show)</li></ul><div class=section-index></div><h2 id=related-content>Related Content</h2><div class=section-index><hr class=panel-line><div class=entry><h5><a href=/building/features/training/>Building >
Features >
Training</a></h5><p class=one-liner>Remotely train health workers</p></div><div class=entry><h5><a href=/building/guides/training/training-cards/>Building >
Quick Guides >
Training >
Training Cards</a></h5><p class=one-liner>Deploy in-app training cards for remote training.</p></div></div><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><div class=d-print-none><h2 class=feedback--title>Feedback</h2><p class=feedback--question>Was this page helpful?</p><button class="btn btn-primary mb-4 feedback--answer feedback--answer-yes">Yes</button>
<button class="btn btn-primary mb-4 feedback--answer feedback--answer-no">No</button><p class="feedback--response feedback--response-yes">Glad to hear it! Please <a href=https://github.com/medic/cht-docs/issues/new>tell us how we can improve</a>.</p><p class="feedback--response feedback--response-no">Sorry to hear that. Please <a href=https://github.com/medic/cht-docs/issues/new>tell us how we can improve</a>.</p></div><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButton.disabled=!0,noButton.disabled=!0},sendFeedback=e=>{if(typeof gtag!="function")return;gtag("event","page_helpful",{event_category:"Helpful",event_label:window.location.pathname,value:e})};yesButton.addEventListener("click",()=>{yesResponse.classList.add("feedback--response__visible"),disableButtons(),sendFeedback(100)}),noButton.addEventListener("click",()=>{noResponse.classList.add("feedback--response__visible"),disableButtons(),sendFeedback(0)})</script><br><br><div class="text-muted mt-5 pt-3 border-top">Last modified 12.09.2024: <a href=https://github.com/medic/cht-docs/commit/84007b2b38c4697f3aee10d6b4785bf1668d4267>Remove extra alias bullet (#1541) (84007b2b)</a></div><div class="d-xl-none d-print-none meta-links"><div class="td-page-meta ml-2 pb-1 pt-2 mb-0"><a href=https://github.com/medic/cht-docs/edit/main/content/en/building/guides/training/training-cards-resources/_index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/medic/cht-docs/issues/new?title=Improve+%27Training%20Cards%20Resources%27&amp;labels=enhancement&amp;body=Page:+/building/guides/training/training-cards-resources/%0aVersion:+2024-09-12%2021:04:47%20+0300%20+0300%0a---" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<button class="btn btn-primary mb-4 feedback--answer feedback--answer-no">No</button><p class="feedback--response feedback--response-yes">Glad to hear it! Please <a href=https://github.com/medic/cht-docs/issues/new>tell us how we can improve</a>.</p><p class="feedback--response feedback--response-no">Sorry to hear that. Please <a href=https://github.com/medic/cht-docs/issues/new>tell us how we can improve</a>.</p></div><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--response-yes"),noResponse=document.querySelector(".feedback--response-no"),disableButtons=()=>{yesButton.disabled=!0,noButton.disabled=!0},sendFeedback=e=>{if(typeof gtag!="function")return;gtag("event","page_helpful",{event_category:"Helpful",event_label:window.location.pathname,value:e})};yesButton.addEventListener("click",()=>{yesResponse.classList.add("feedback--response__visible"),disableButtons(),sendFeedback(100)}),noButton.addEventListener("click",()=>{noResponse.classList.add("feedback--response__visible"),disableButtons(),sendFeedback(0)})</script><br><br><div class="text-muted mt-5 pt-3 border-top">Last modified 01.10.2024: <a href=https://github.com/medic/cht-docs/commit/7df3d7a2f6655260a1c29e9bafa25a5064130cf5>chore: add clarity to training card guide (#1577) (7df3d7a2)</a></div><div class="d-xl-none d-print-none meta-links"><div class="td-page-meta ml-2 pb-1 pt-2 mb-0"><a href=https://github.com/medic/cht-docs/edit/main/content/en/building/guides/training/training-cards-resources/_index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/medic/cht-docs/issues/new?title=Improve+%27Training%20Cards%20Resources%27&amp;labels=enhancement&amp;body=Page:+/building/guides/training/training-cards-resources/%0aVersion:+2024-10-01%2016:38:07%20+0300%20+0300%0a---" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/medic/cht-core/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a></div></div></div></main></div></div><footer class="td-footer row d-print-none"><div class=container-fluid><div class="row mx-md-2"><div class="td-footer__left col-6 col-sm-4 order-sm-1"></div><div class="td-footer__right col-6 col-sm-4 order-sm-3"></div><div class="td-footer__center col-12 col-sm-4 py-2 order-sm-2"><span class=td-footer__copyright>&copy;
2024
<span class=td-footer__authors>CHT</span></span><span class=td-footer__all_rights_reserved>All Rights Reserved</span><span class=ms-2><a href="https://docs.google.com/document/d/1MaI1rgYMNyCZF2eEjBuvnBDoCYHDKlx4k_N5pkDiWu8/edit?usp=sharing" target=_blank rel=noopener>Privacy Policy</a></span></div></div></div></footer></div><script src=/js/main.min.67106435b48bd4be8da89992919b230eaa1fd426e8856556b88a03a942114880.js integrity="sha256-ZxBkNbSL1L6NqJmSkZsjDqof1CbohWVWuIoDqUIRSIA=" crossorigin=anonymous></script><script defer src=/js/click-to-copy.min.73478a7d4807698aed7e355eb23f9890ca18fea3158604c8471746d046702bad.js integrity="sha256-c0eKfUgHaYrtfjVesj+YkMoY/qMVhgTIRxdG0EZwK60=" crossorigin=anonymous></script><script src=/js/tabpane-persist.js></script></body></html>
Loading

0 comments on commit e55ec44

Please sign in to comment.