From 6d040e21b96a85af0a50d0f2d5032b092642fc8d Mon Sep 17 00:00:00 2001 From: tamslo Date: Mon, 3 Feb 2025 11:21:21 +0100 Subject: [PATCH] docs(app): smaller user instruction adaptions --- app/CONTRIBUTING.md | 10 ++++-- docs/User-instructions.html | 67 +++++++++++++++++++++---------------- 2 files changed, 47 insertions(+), 30 deletions(-) diff --git a/app/CONTRIBUTING.md b/app/CONTRIBUTING.md index 971d42fc..2c739780 100644 --- a/app/CONTRIBUTING.md +++ b/app/CONTRIBUTING.md @@ -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 diff --git a/docs/User-instructions.html b/docs/User-instructions.html index 6b6fc32a..704c0cee 100644 --- a/docs/User-instructions.html +++ b/docs/User-instructions.html @@ -1,9 +1,9 @@ - + PharMe: Getting Started & Further Resources @@ -175,14 +175,15 @@

PharMe: Getting Started & Further Resources

In this document you find all information to get started with PharMe and further support while using it:

- These resources are also available in the app. - If you have any questions or need further assistance, please reach out via e-mail: ehivepgx@mssm.edu. + These resources are also available in the App. + If you have any questions or need further assistance, please reach out via + e-mail: ehivepgx@mssm.edu.

We hope you will enjoy using PharMe and that you will learn useful @@ -203,7 +204,9 @@

Welcome to PharMe!

- 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.
@@ -225,7 +228,8 @@

One Size Does Not Fit All

warning
- 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.
@@ -240,7 +244,9 @@

One Size Does Not Fit All

Genome Power Unlocked to Improve Your Health

- 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.

This field of medicine is called pharma-co-genomics (PGx). @@ -250,7 +256,9 @@

Genome Power Unlocked to Improve Your Health

info
- The medical field of how your genes affect how medications work in your body is called pharma-co-genomics (PGx). + PGx + (pharma-co-genomics) is the medical field of how your genes + affect how medications work in your body.
@@ -275,7 +283,7 @@

Tailored Just for You

-

PharMe only includes medications with clinical PGx guidelines from CPIC and the FDA.

+

PharMe only includes medications with clinical PGx guidelines from CPIC and the FDA.

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. @@ -311,7 +319,7 @@

Keeping Your Information Safe

App Tour

-

The first part will not be included in the app

+

The first part will not be included in the App

@@ -350,7 +358,7 @@

Login

need to update the screenshot after content updates

App Intro

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).
@@ -367,7 +375,7 @@

Update Current Medications

You will also be able to edit your current medications later in the - app. + App.

not sure if we should include this here, what do you think?

@@ -390,7 +398,10 @@

Update Current Medications

-

From now on this will be included in the app; headings will say "Part I: [heading] (I/N)"

+ +
+ +

From now on this will be included in the App; headings will say "Part I: [heading] (I/N)"

@@ -403,9 +414,9 @@

Getting Around

At the bottom of your screen, you'll find four main buttons: "Medications", "Genes", "FAQ", and "More".

-

In the app, "again in the app" will be "again later"

-

Want to repeat this tour again in the app? Just go to "More" and tap - "Repeat app tour".

+

In the App, "again in the App" will be "again later"

+

Want to repeat this tour again in the App? Just go to "More" and tap + "Repeat App tour".

Finding Medications

@@ -479,7 +490,7 @@

Understanding Your Genes

need to update the more screenshot after content updates

FAQ & Additional Features

-

Need help? Use "More" to get in touch with us or learn about the app, +

Need help? Use "More" to get in touch with us or learn about the App, or check the FAQ for common questions.

Under "More" you can also edit your current medication list.

@@ -490,7 +501,7 @@

Learn About Genetics

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".

For more information on PGx:

@@ -532,10 +543,10 @@

What is PGx?

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.

Why is PGx important?

@@ -590,8 +601,8 @@

What do my gene results mean?

  • Your gene versions (called genotype): You have two copies for one gene, one from your mom and one from your dad. One gene copy is called an "allele".
  • How your genes affect your body (called phenotype): 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.
    • -

    in the app the "the learn about genomics, or in the app" part will be omitted

    - For more information about genetics please refer to the learn about genetics section, or in the app "More" > "Learn about genetics". +

    in the App the "the learn about genomics, or in the App" part will be omitted

    + For more information about genetics please refer to the learn about genetics section, or in the App "More" > "Learn about genetics".

    Which medications does PharMe include?

    @@ -630,7 +641,7 @@

    Can other medications change my results?

    The following medications are included in PharMe that can change your results:

    -

    Will also leave out gene names in app FAQ (currently only CYP2D6 anyways)

    +

    Will also leave out gene names in App FAQ (currently only CYP2D6 anyways)

    Strong inhibitors:

    • Bupropion (brand names: Aplenzin, Auvelity, Budeprion, Contrave, Forfivo, Wellbutrin, Zyban)
      • @@ -698,7 +709,7 @@

      How do you protect my gene information?

    • Never sharing it with others
    • Doing all calculations on your phone
    • Not storing any information that could tell us who you are
      • -
    • Asking you to log in again if you do not use the app for some time
      • +
    • Asking you to log in again if you do not use the App for some time