Years of collaboration
2025
Context
AI security for apps and agents
CalypsoAI tools sit between users and proprietary datasets, acting as a firewall when AI is being used to mine and report on the data. The company’s reputation for protecting data while enabling powerful analytics has been building since 2016, but growth has accelerated significantly in the last couple of years as customers grapple with the opportunities and risks of deploying AI.
Aim
Combining API docs and product docs
It was critical to provide a bridge between the developer-oriented API documentation and the content aimed at regular users of the CalypsoAI Platform. What was needed was professional and modern documentation that will not only guide new users through the onboarding steps and explain key concepts, but also support existing users with common use-case scenarios.
Want to find out more?
Challenges
Addressing different audiences and designing the onboarding steps from scratch
To meet CalypsoAI expectations, the 3di team needed to create documentation that caters not only for API developers, but also for non-dev users who would like to understand the conceptual information behind what the company services offered. This meant striking the right balance between selling features and providing detailed technical information.
The 3di team also had to re-design the whole onboarding journey as the existing documentation failed to guide the user successfully and new joiners required frequent contacts with the company support.
Finally, with two separate output websites, the 3di team had to work in different authoring environments, aiming at a consistent look and feel between the VitePress dev portal and the Hubspot knowledge base.
Solution
A modern developer portal aligned with a robust knowledge base
The 3di team:
- Designed a thorough information model that covered both API documentation and product documentation.
- Designed a content plan that included not only step-by-step tutorials for developers, but also articles explaining the fundamental concepts of the CalypsoAI services to non-developer audiences.
- Created a modern developer portal based on Markdown.
- Updated CalypsoAI’s knowledge base and aligned it with the developer portal.
- Maintained linguistic and stylistic consistency between two different outputs.
- Established an efficient workflow that included information gathering and detailed review process.
Want to find out more?
Result
Engaging documentation aimed at dev and non-dev audience alike
The 3di team:
- Delivered a modern developer portal with detailed API documentation, including a mix of tutorials, specific use-case scenarios, and conceptual articles.
- Improved the existing knowledge base for regular users.
- Covered the whole onboarding journey with guided instructions for every step in the process.
- Built and implemented a content creation workflow that aligned with CalypsoAI’s natural development sprint cycles.