Product Updates
Product release: Sequence diagrams & Code walkthrough
Changelog #9: Product release update for 👏
Job Rietbergen
• Sep 20, 2023
Since May we spoke with 200+ ambitious companies that want to level up their developer experience. A part of these companies were a match made in heaven for our product from the get-go. At the same time we frequently heard people say things like:
“I love the diagrams, but I also need something that’s more flexible to explain the full integration flow”
“I need to explain my SDKs, code snippets or demo applications.”
As we progressed through these conversations it became clear to us that a large number of companies faced the same issues. So we got to work and built a new way to explain code to developers and a completely new sequence diagram builder to guide developers through the integration flow, from start to finish.
Let’s dive into these new flagship features of the platform.
Sequence diagrams
You can now create captivating and interactive sequence diagrams following our new release. Define the lifelines (vertical lines) and drag the horizontal lines between them to tell the integration story. For example, in a payments scenario, lifelines can represent objects such as a bank system or customer. Each instance in an interaction is represented by a lifeline.
Use the sequence diagram to illustrate your API calls or add your own content/text. The lifelines and messages are color coded to quickly see the patterns and connections.
Code walkthrough
In the Alphadoc platform you can now easily start adding code walkthroughs into pages and guides. Go ahead and add your code snippets, SDK or demo applications into it. You can have multiple files side by side, when developers go through it, based on the step they are looking at, it will jump to the right file.
In the editor you can define on a codeline level what you want to highlight and explain in depth what is happening in the code. Syntax highlighting ensures the correct highlighting of your code.
Plus!
Authentication variables
Add your auth credentials in a single location and see it populate in every single API call in the platform. Developers can now navigate through each step by just clicking ‘tryout’.
Loom and Arcade embeds
Embed Loom videos and Arcade product tours to up your docs game. Easily drop the link into your docs and we take care of the rest.
Getting Started
To start building your docs & DX with Alphadoc, please fill out the sign-up form or visit our website at alphadoc.io. We’ll review your request for access within 1 business day. If granted access, you can upload your OpenAPI spec and easily create a compelling developer experience.
Happy coding!
Follow our journey 🔆
Interested in what we’re building? Shoot us a message at post@alphadoc.io or follow our journey:
