Document your app

Once you've deployed your app to Health Universe, it's time to Document it. This step helps ensure your app is discoverable, well-understood, and appropriately used.

Here's how to document your app effectively:

1. Go to Your App Page

Navigate to your app’s page on healthuniverse.com.

2. Enter Edit Mode

Click Edit in the top-right corner of your app page to begin editing.

3. Update Core Information

You can now modify:

• App Name

• Description

• Research Area

  

Make sure these are clear, concise, and descriptive to help Navigator accurately surface your app in the right clinical or administrative contexts.

4. Add Documentation

In addition to the basics, you’ll have the option to add detailed paragraphs for each of the following sections:

• 🩺 Use Case:

  • Describe the specific clinical or administrative scenario your app supports. Be specific — this helps Navigator understand when to surface your app.

• 📚 Evidence:

  • Add any relevant data, clinical studies, validation results, or references that support the app’s effectiveness or accuracy.

• ⚠️ Limitations:

  • Be transparent about what the app cannot do or situations where caution should be used.

• 💡 Owner’s Insight:

  • Share the developer’s or clinician’s unique perspective. Why did you build this app? How do you envision it being used? This adds credibility and context.

  

5. Modify App Settings

• Hide GitHub Repository

  • Toggle Yes/No to choose whether to hide your GitHub repo from the app page.

• Privacy Setting

  • Set your app to Private (only you can access it) or Public (anyone with the link can use it).

• Delete Metadata

  • If needed, you can delete your app’s metadata from this section.

6. Submit & Preview

• Click Save Changes to save any edits you made

• Refresh the page

• Go to the Overview tab

• Scroll down to view your updates live

  

Documenting your app thoroughly not only helps others use it properly — it also improves its visibility and utility within the platform.