All Cases
Why CarePortals Chose WriteChoice to Structure Documentation Across Three Distinct Health Tech Products
A single embedded Swagger page was CarePortals' entire developer experience. WriteChoice turned it into a structured, branded documentation portal covering three products, a full glossary, and a Diataxis-driven content architecture that developers could actually navigate.
CHALLENGE
Raw, Unstructured Docs
SOLUTION
Multi-Product Documentation Portal
RESULT
20+ Developer Hours Saved Per Week
The Problem: Three Products, No Documentation Strategy, and a Single Swagger Page
CarePortals is a health tech SaaS company offering three distinct products: a CRM portal, an ERM portal, and a Patient Portal, each serving different users with different workflows and technical requirements. When they engaged WriteChoice, their documentation situation did not reflect that complexity in any useful way.
What they had was a collection of raw notes in Notion, a partial setup in FeatureBase, and a single embedded Swagger page linked from their developer section. Clicking the developer link on CarePortals' website took you directly to an unstyled, unguided list of API endpoints with no context, no getting started flow, and no separation between the three products.
The consequences for developers and internal teams were significant:
There was no clear separation between the three products. A developer integrating the Patient Portal API had no straightforward way to find only what was relevant to them.
Core concepts and terminology were never defined. CarePortals' domain involved specialized health tech terms that required explanation before a developer could meaningfully engage with the product.
There were no how-to guides or tutorials. The Swagger page described endpoints but gave developers no path to follow, leaving them to reverse-engineer the integration process on their own.
CarePortals' internal developers were spending more than 20 hours per week managing documentation tasks and answering integration questions, time that should have gone toward building product features.
CarePortals needed a documentation system that matched the sophistication of their products and the diversity of the users relying on them.
How WriteChoice Solved It
WriteChoice worked with CarePortals on a daily basis, running daily standups and weekly review calls to move quickly and stay aligned with their product teams throughout the engagement.
Step 1: Product Discovery and Concept Mapping
Before writing a single page, we needed to fully understand what CarePortals built and who used it. We ran structured discovery sessions across all three products, mapping the users of each portal, the workflows they needed to complete, and the terminology that underpinned the whole system.
From this discovery work, we produced a comprehensive product glossary, giving every future reader a shared vocabulary before they engaged with technical content. This was particularly important in the health tech context, where domain-specific terms carry precise meanings that cannot be assumed.
Step 2: Information Architecture Using the Diataxis Framework
We structured the entire documentation portal using the Diataxis framework, a proven content architecture that separates documentation into four distinct page types: references, explanations, concepts, and guides and tutorials.
This distinction matters in practice. A developer who needs to understand what something is gets an explanation. A developer who needs to know how to do something specific gets a step-by-step guide. Neither bleeds into the other, so users always know what they are reading and why.
Within this structure, we clearly separated the three CarePortals products so that each had its own documentation section, its own user context, and its own navigation path. A CRM user and a Patient Portal developer could each find what they needed without encountering content that did not apply to them.
Step 3: Full Content Build on ReadMe
With the architecture defined, we built the documentation on ReadMe, migrating and transforming the Notion notes and FeatureBase content into structured, properly formatted documentation pages.
The final portal included:
A product glossary covering all domain-specific terminology across the three portals
Concept and explanation pages covering the core modules of each product
Authentication guides and main API flow documentation, replacing the bare Swagger page
How-to guides covering the primary user flows for the CRM, ERM, and Patient Portal
Branded ReadMe portal with CarePortals' visual identity, giving the developer section the same level of professionalism as the rest of their product
The Impact
RESULT
20+ Developer hours saved per week
RESULT
Faster integration time
RESULT
Clear product separation across three distinct products
20+ developer hours saved per week, as CarePortals' internal team was freed from documentation management and integration support to focus on core product work.
Faster developer integration time, with structured getting started flows and authentication guides replacing an unguided Swagger page that previously gave developers no clear path forward.
A professional developer experience from first click. Visiting the developer section now takes users to a well-structured, branded ReadMe portal rather than a raw endpoint list.
Clear product separation across three distinct portals, so every user type finds only the content relevant to them.
A scalable documentation foundation built on the Diataxis framework, designed to grow with the product without losing its structure or clarity.
"Our developers were spending hours every week answering questions that good documentation would have handled automatically. WriteChoice built the system that freed them to focus on the product. The difference in our developer experience was immediate."
— CarePortals Product Team
Ready to Turn Your Documentation into a Growth Engine?
WriteChoice builds and maintains developer documentation portals that accelerate product adoption, reduce support costs, and free your team to focus on what they do best.
CLIENT
CarePortals
INDUSTRY
Health Tech / SaaS
PARTNERSHIP
6-Month Project