Documentation

Web design

user experience

Disclaimer

Due to privacy reasons, I can't share a significant chunk of my work for this project as it's not public just yet. But it's been my favorite to work on, so lets keep it brief 👇

What’s terra?

Terra is an API that enables seamless integrations of health and fitness data from wearables and other devices which helps the healthcare provider to gain insights into customer’s fitness and health habits.

My role / tasks

As the sole product designer I was responsible for the entire redesign of Terra’s entire documentation

Duration

2 Month

Tools

Figma, notion

What’s the docs

Terra’s documentation is looking to be redesigned, the documentation is used to as a resource to help developers integrated Terra in to their own systems

Main pain points

Difficult navigation

  • Users reported that while all the necessary information was present, navigating through the system proved challenging, making it difficult to locate specific details.


  • Upon setting up the REST API, users commonly think it was for acquiring real-time data. However, the process is primarily tailored for historical data, with additional steps required for accessing real-time information.

Lacked convenience

  • Users express a preference for the convenience of viewing and copying entire code snippets, rather than having to manually piece together individual elements.


  • The user base consisted of two distinct types: our existing customers, who already engage with our products, and potential customers exploring our offerings for the first time.

Constraints

Lack of knowledge

  • I lacked in-depth knowledge about our products while redesigning a feature that included detailed information on their functionality and implementation.


  • To address this, I held regular meetings with engineers, asking them specific questions to better understand the product details. I also collaborated with them on reorganizing the Information Architecture (IA) through card sorting.

Lack of research participants

  • Due to external constraints, obtaining external participants for design testing became challenging.


  • Fortunately, I leveraged the presence of recent developer hires within our team. These new members, being unfamiliar with our product, served as valuable participants, actively engaging with our designs while relying on our documentation to enhance their understanding of Terra’s products.

Execution Overview

  • Conducted internal research to better comprehend user pain points.


  • Illustrated potential solutions for addressing the pain points.


  • Collaborated with developers on card sorting test's to establish a new Information Architecture (IA).


  • Developed a design system tailored for documentation purposes.


  • Produced project documentation, encompassing annotations, user flows, and screen recordings, primed for a seamless handoff.

© 2023 by Caroline Sia Made with ❤️🍵

Documentation

Web design

user experience

Disclaimer

Due to privacy reasons, I can't share a significant chunk of my work for this project as it's not public just yet. But it's been my favorite to work on, so lets keep it brief 👇

What’s terra?

Terra is an API that enables seamless integrations of health and fitness data from wearables and other devices which helps the healthcare provider to gain insights into customer’s fitness and health habits.

My role / tasks

As the sole product designer I was responsible for the entire redesign of Terra’s entire documentation

Duration

2 Month

Tools

Figma, notion

What’s the docs

Terra’s documentation is looking to be redesigned, the documentation is used to as a resource to help developers integrated Terra in to their own systems

Main pain points

Difficult navigation

  • Users reported that while all the necessary information was present, navigating through the system proved challenging, making it difficult to locate specific details.


  • Upon setting up the REST API, users commonly think it was for acquiring real-time data. However, the process is primarily tailored for historical data, with additional steps required for accessing real-time information.

Lacked convenience

  • Users express a preference for the convenience of viewing and copying entire code snippets, rather than having to manually piece together individual elements.


  • The user base consisted of two distinct types: our existing customers, who already engage with our products, and potential customers exploring our offerings for the first time.

Constraints

Lack of knowledge

  • I lacked in-depth knowledge about our products while redesigning a feature that included detailed information on their functionality and implementation.


  • To address this, I held regular meetings with engineers, asking them specific questions to better understand the product details. I also collaborated with them on reorganizing the Information Architecture (IA) through card sorting.

Lack of research participants

  • Due to external constraints, obtaining external participants for design testing became challenging.


  • Fortunately, I leveraged the presence of recent developer hires within our team. These new members, being unfamiliar with our product, served as valuable participants, actively engaging with our designs while relying on our documentation to enhance their understanding of Terra’s products.

Execution Overview

  • Conducted internal research to better comprehend user pain points.


  • Illustrated potential solutions for addressing the pain points.


  • Collaborated with developers on card sorting test's to establish a new Information Architecture (IA).


  • Developed a design system tailored for documentation purposes.


  • Produced project documentation, encompassing annotations, user flows, and screen recordings, primed for a seamless handoff.

© 2023 by Caroline Sia Made with ❤️🍵

Documentation

Web design

user experience

Disclaimer

Due to privacy reasons, I can't share a significant chunk of my work for this project as it's not public just yet. But it's been my favorite to work on, so lets keep it brief 👇

What’s terra?

Terra is an API that enables seamless integrations of health and fitness data from wearables and other devices which helps the healthcare provider to gain insights into customer’s fitness and health habits.

My role / tasks

As the sole product designer I was responsible for the entire redesign of Terra’s entire documentation

Duration

2 Month

Tools

Figma, notion

What’s the docs

Terra’s documentation is looking to be redesigned, the documentation is used to as a resource to help developers integrated Terra in to their own systems

Main pain points

Difficult navigation

  • Users reported that while all the necessary information was present, navigating through the system proved challenging, making it difficult to locate specific details.


  • Upon setting up the REST API, users commonly think it was for acquiring real-time data. However, the process is primarily tailored for historical data, with additional steps required for accessing real-time information.

Lacked convenience

  • Users express a preference for the convenience of viewing and copying entire code snippets, rather than having to manually piece together individual elements.


  • The user base consisted of two distinct types: our existing customers, who already engage with our products, and potential customers exploring our offerings for the first time.

Constraints

Lack of knowledge

  • I lacked in-depth knowledge about our products while redesigning a feature that included detailed information on their functionality and implementation.


  • To address this, I held regular meetings with engineers, asking them specific questions to better understand the product details. I also collaborated with them on reorganizing the Information Architecture (IA) through card sorting.

Lack of research participants

  • Due to external constraints, obtaining external participants for design testing became challenging.


  • Fortunately, I leveraged the presence of recent developer hires within our team. These new members, being unfamiliar with our product, served as valuable participants, actively engaging with our designs while relying on our documentation to enhance their understanding of Terra’s products.

Execution Overview

  • Conducted internal research to better comprehend user pain points.


  • Illustrated potential solutions for addressing the pain points.


  • Collaborated with developers on card sorting test's to establish a new Information Architecture (IA).


  • Developed a design system tailored for documentation purposes.


  • Produced project documentation, encompassing annotations, user flows, and screen recordings, primed for a seamless handoff.

© 2023 by Caroline Sia Made with ❤️🍵