Skip to content

Commit

Permalink
docs(app): smaller user instruction adaptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@tamslo
tamslo committed Feb 3, 2025
1 parent d3dbf9c commit 6d040e2
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 30 deletions.
10 changes: 8 additions & 2 deletions app/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,14 @@ manually if changes in the app content occur (at least the screenshots are
linked and do not need to be updated after re-generation).

We decided to host a PDF of the user instructions (for the study). To create
this PDF, open the HTML file in a browser (tested with Chrome) and print with
"Save to PDF".
this PDF, follow these steps:

1. Open the HTML file in Chrome
2. Print with "Save to PDF" using default settings, format US Letter
3. Add page numbers [online](https://www.ilovepdf.com/add_pdf_page_number)
- Position: bottom center
- Text: `{n} of {p}`
- Font size: 10

## Adapting test data

Expand Down
67 changes: 39 additions & 28 deletions docs/User-instructions.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
TODO: The app content should be included from the `app_en.arb` in the future
TODO: The App content should be included from the `app_en.arb` in the future
and be generated as in the actual content to avoid manual updates (and
especially forgetting about manual updates).
-->

<!DOCTYPE html>
<html>
<head>
<title>PharMe: Getting Started & Further Resources</title>
Expand Down Expand Up @@ -175,14 +175,15 @@ <h1>PharMe: Getting Started & Further Resources</h1>
In this document you find all information to get started with PharMe and further support while using it:
</p>
<ul>
<li>An app intro that explains what PharMe can do</li>
<li>An app tour, which leads through PharMe's main functions</li>
<li>An App intro that explains what PharMe can do</li>
<li>An App tour, which leads through PharMe's main functions</li>
<li>Resources to learn about genetics</li>
<li>Frequently asked questions (FAQ)</li>
</ul>
<p>
These resources are also available in the app.
If you have any questions or need further assistance, please reach out via e-mail: <a href="mailto:[email protected]">[email protected]</a>.
These resources are also available in the App.
If you have any questions or need further assistance, please reach out via
e-mail: <a href="mailto:[email protected]">[email protected]</a>.
</p>
<p>
We hope you will enjoy using PharMe and that you will learn useful
Expand All @@ -203,7 +204,9 @@ <h3>Welcome to PharMe!</h3>
<i class="fa-classic fa-solid fa-puzzle-piece disclaimer-icon"></i>
</div>
<div>
Your genes are just one piece of the puzzle. Many things affect how medications work, like your weight, age, other health conditions, or other medications you are taking.
Your genes are just one piece of the puzzle. Many things affect
how medications work, like your weight, age, other health
conditions, or other medications you are taking.
</div>
</div>
</div>
Expand All @@ -225,7 +228,8 @@ <h3>One Size Does Not Fit All</h3>
<span class="material-icons-round disclaimer-icon">warning</span>
</div>
<div>
Never change or stop your medications without talking to your pharmacist or doctor first.
Never change or stop your medications without talking to your
pharmacist or doctor first.
</div>
</div>
</div>
Expand All @@ -240,7 +244,9 @@ <h3>One Size Does Not Fit All</h3>
<div class="onboarding-texts">
<h3>Genome Power Unlocked to Improve Your Health</h3>
<p>
PharMe tells you if your genes might make certain medications work differently than expected, cause unwanted side effects, or not work well enough.
PharMe tells you if your genes might make certain medications work
differently than expected, cause unwanted side effects, or not work
well enough.
</p>
<p>
This field of medicine is called pharma-co-genomics (PGx).
Expand All @@ -250,7 +256,9 @@ <h3>Genome Power Unlocked to Improve Your Health</h3>
<span class="material-icons-round disclaimer-icon">info</span>
</div>
<div>
The medical field of how your genes affect how medications work in your body is called pharma-co-genomics (PGx).
<span style="font-weight: bold;">PGx</span>
(pharma-co-genomics) is the medical field of how your genes
affect how medications work in your body.
</div>
</div>
</div>
Expand All @@ -275,7 +283,7 @@ <h3>Tailored Just for You</h3>
<i class="fa-classic fa-solid fa-circle-check disclaimer-sub-icon"></i>
</div>
<div>
<p>PharMe only includes medications with clinical PGx guidelines from CPIC and the FDA.</p>
<p style="margin-top: 0;">PharMe only includes medications with clinical PGx guidelines from CPIC and the FDA.</p>
<p>
While only to a small percentage of medications have PGx guidelines, they are among the most commonly prescribed ones.
If you cannot find a medication in PharMe, there may not be enough evidence for meaningful gene interactions.
Expand Down Expand Up @@ -311,7 +319,7 @@ <h3>Keeping Your Information Safe</h3>

<h2 id="app-tour">App Tour</h2>

<p class="reviewer-comment">The first part will not be included in the app</p>
<p class="reviewer-comment">The first part will not be included in the App</p>
<div class="app-tour-container">
<div class="app-screenshot-container">
<img class="app-screenshot" src="./screenshots/accept-terms.png" />
Expand Down Expand Up @@ -350,7 +358,7 @@ <h3>Login</h3>
<p class="reviewer-comment">need to update the screenshot after content updates</p>
<h3>App Intro</h3>
After successfully downloading your data, you will get an overview about
what PharMe can do in the app intro (also see the app intro above).
what PharMe can do in the App intro (also see the App intro above).
</div>
</div>
<hr>
Expand All @@ -367,7 +375,7 @@ <h3>Update Current Medications</h3>
</p>
<p>
You will also be able to edit your current medications later in the
app.
App.
</p>
<p class="reviewer-comment">not sure if we should include this here, what do you think?</p>
<p>
Expand All @@ -390,7 +398,10 @@ <h3>Update Current Medications</h3>
</ul>
</div>
</div>
<p class="reviewer-comment">From now on this will be included in the app; headings will say "Part I: [heading] (I/N)"</p>

<div class="force-pagebreak"></div>

<p class="reviewer-comment">From now on this will be included in the App; headings will say "Part I: [heading] (I/N)"</p>
<!-- <hr> -->
<div class="app-tour-container">
<div class="app-screenshot-container" style="align-self: center;">
Expand All @@ -403,9 +414,9 @@ <h3>Getting Around</h3>
At the bottom of your screen, you'll find four main buttons:
"Medications", "Genes", "FAQ", and "More".
</p>
<p class="reviewer-comment">In the app, "again in the app" will be "again later"</p>
<p style="font-weight: bold;">Want to repeat this tour again in the app? Just go to "More" and tap
"Repeat app tour".</p>
<p class="reviewer-comment">In the App, "again in the App" will be "again later"</p>
<p style="font-weight: bold;">Want to repeat this tour again in the App? Just go to "More" and tap
"Repeat App tour".</p>
</p>
<hr>
<h3 style="margin-top: 1em">Finding Medications</h3>
Expand Down Expand Up @@ -479,7 +490,7 @@ <h3>Understanding Your Genes</h3>
<div class="app-tour-content">
<p class="reviewer-comment">need to update the more screenshot after content updates</p>
<h3>FAQ & Additional Features</h3>
<p style="font-weight: bold;">Need help? Use "More" to get in touch with us or learn about the app,
<p style="font-weight: bold;">Need help? Use "More" to get in touch with us or learn about the App,
or check the FAQ for common questions.</p>
<p>Under "More" you can also edit your current medication list.</p>
</div>
Expand All @@ -490,7 +501,7 @@ <h2 id="learn-about-genetics">Learn About Genetics</h2>

<p>
Please refer to the links below to learn more about PGx and genetics in general.
You can also open the links from the app, under "More" > "Learn about genetics".
You can also open the links from the App, under "More" > "Learn about genetics".
</p>

<p>For more information on PGx:</p>
Expand Down Expand Up @@ -532,10 +543,10 @@ <h4>What is PGx?</h4>
</p>
<p>
For example, if a protein that activates a medication
works slower than expected, it may not work properly for you because you do
not have enough working versions of the medication in your body. In such a
case, you might need a higher dose of the medication or might need to use a
different medication.
works slower than expected, the medication may not work properly for you
because you do not have enough working versions of the medication in your
body. In such a case, you might need a higher dose of the medication or
might need to use a different medication.
</p>

<h4>Why is PGx important?</h4>
Expand Down Expand Up @@ -590,8 +601,8 @@ <h4>What do my gene results mean?</h4>
<li>Your gene versions (called <span style="font-weight: bold;">genotype</span>): You have two copies for one gene, one from your mom and one from your dad. One gene copy is called an "allele".</li>
<li>How your genes affect your body (called <span style="font-weight: bold;">phenotype</span>): in PGx, it usually shows if a gene version might cause a bad reaction to a medication or how fast your body processes a drug.</li>
</ul>
<p class="reviewer-comment">in the app the "the learn about genomics, or in the app" part will be omitted</p>
For more information about genetics please refer to the learn about genetics section, or in the app "More" > "Learn about genetics".
<p class="reviewer-comment">in the App the "the learn about genomics, or in the App" part will be omitted</p>
For more information about genetics please refer to the learn about genetics section, or in the App "More" > "Learn about genetics".
</p>

<h4>Which medications does PharMe include?</h4>
Expand Down Expand Up @@ -630,7 +641,7 @@ <h4>Can other medications change my results?</h4>
<p>
The following medications are included in PharMe that can change your results:
</p>
<p class="reviewer-comment">Will also leave out gene names in app FAQ (currently only CYP2D6 anyways)</p>
<p class="reviewer-comment">Will also leave out gene names in App FAQ (currently only CYP2D6 anyways)</p>
<p style="font-style: italic;">Strong inhibitors:</p>
<ul>
<li>Bupropion (brand names: Aplenzin, Auvelity, Budeprion, Contrave, Forfivo, Wellbutrin, Zyban)</li>
Expand Down Expand Up @@ -698,7 +709,7 @@ <h4>How do you protect my gene information?</h4>
<li>Never sharing it with others</li>
<li>Doing all calculations on your phone</li>
<li>Not storing any information that could tell us who you are </li>
<li>Asking you to log in again if you do not use the app for some time</li>
<li>Asking you to log in again if you do not use the App for some time</li>
</ul>
</p>

Expand Down

0 comments on commit 6d040e2

Please sign in to comment.