Health Universe
  • Core Concepts
    • Overview of Health Universe
    • How Health Universe Works
  • Building Apps in Health Universe
    • Getting started with Health Universe
      • Create a Health Universe Account
      • Create a Github Account
      • Link your Github Account to your Health Universe Account
    • Creating a Workspace
    • Developing your Health Universe App
      • Streamlit vs FastAPI
      • Working in Streamlit
        • Typical Project Setup
        • Your First Health Universe App
        • Streamlit Best Practices
      • Working in FastAPI
        • Typical Project Setup
        • Your First Health Universe App
        • Navigator FastAPI best practices
    • Deploying your app to Health Universe
      • Deploying to Health Universe
      • Secret Management
      • Connecting to an LLM
      • Connecting to an external data source
  • Testing your app
  • Re-deploying your app
  • Document your app
  • Deleting your App on Health Universe
  • Additional resources
    • Data Formats, Standards & Privacy
    • External Tools and Libraries
Powered by GitBook
On this page

Was this helpful?

Document your app

PreviousRe-deploying your appNextDeleting your App on Health Universe

Last updated 19 days ago

Was this helpful?

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 .

2. Enter Edit Mode

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

3. Update Core Information

You can now modify:

  • App Name

  • Research Area

  • Description

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.

4. Submit & Preview

  • Click Submit to save your changes

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

healthuniverse.com