Jargon Support, Concepts, Documentation, and More
Need Additional Support?
We're here for you and happy to answer questions. Don't hesitate to reach out!
When to use Jargon
If your team is building a voice or multimodal experience that goes beyond prototype-level of complexity, Jargon is for you. Jargon was built from the ground-up for multi-disciplinary teams, so they can collaborate together while focusing on what they do best as individuals. As a purpose-built product, Jargon offers capabilities that are unique to authoring and maintaining voice-first content, such as SSML editing, managing dynamic variables, and adding response variety. Jargon’s solution integrates with today’s leading voice platforms so you don’t have to re-create the content in multiple places. Moreover, Jargon allows you to manage content across languages, so you can centralize your app logic while localizing the content, leading to a more maintainable product.
The content managed in Jargon can be accessed at runtime by a voice application via the Jargon Platform SDK, which is free and open source. In addition to live content services, teams always have the option to download content releases and manage content without a live integration. For developer documentation, please follow this link.
How to Structure Voice Content
As a common software development practice, it is best to manage content separately from the business logic of the application. This involves building a library of potential responses in a content management system (CMS) that can be pulled into the application when triggered by an intent. Using a voice CMS, like Jargon, for multimodal content allows teams to focus on the quality of the content while the CMS does the heavy lifting to stitch together the different content components.
What are Voice App Responses?
When a user engages with a voice app, the response sent back to the user is the voice app response. It can come in any combination of audio and visual components. The response modality can differ depending on the environment and the situation that the user is in. For example, if a customer asks an in-car voice app for flight details while driving to the airport, the app might deliver a speech response so the customer can keep her eyes on the road. In contrast, if the same customer is waiting in line at security and asks a voice app to upgrade her seat, the app might deliver a visual of the seats available before she confirms the upgrade.
Voice Content Collaboration
Having content managed in a single hub allows for a single version of the truth among multiple team members. Team members can update content easily without the risk of inadvertently breaking the application. When content changes are made, other team members can easily see what has changed. Content validation and version control provide built-in safeguards for the content.
Voice App Version Control
All content changes made in Jargon are tracked with version control. When a team member makes content changes, she can make them available to the rest of the project's collaborators. If two people modify a piece of content at the same time, Jargon shows the content changes side-by-side and allows the authors to select the version they want to keep. Such functionality ensures that all collaborators stay in sync directly in Jargon, instead of having multiple versions of the content flying around in email or residing in ever-changing spreadsheets.
Reviewing Voice App Content
After changes have been made to a speech component, there is the option to compare the changes made with a previous version. Use the "compare it" button below the speech editor to view the two versions side by side and simulate how they sound. Each app response also has a unique URL to allow team members to send a specific response to another team member for review. Once the content is to a point where it's ready for the next phase of development, a release can be created and tagged with a particular development environment - development, production, etc.
Voice App Content Hand-off
During voice app development, there are phases when the content needs to be handed off to another team member or another team altogether. For example, once the initial content structure is in place, the designers or copywriters will want to hand off the content to developers to begin building the app. Furthermore, there might be stakeholders like marketing, legal, or a client that will want to approve of the content. Granting permission in Jargon to these individuals is a great way to maintain a single source of truth for content changes.
Jargon provides a safeguard for content creators and authors to make content changes without breaking code. By using the Jargon Platform SDK, response components are automatically structured for the respective voice assistant when a new release is created.
Speech Synthesis Markup Language (SSML)
Using SSML can transform a voice experience from sounding robotic and getting names, places and technical terms wrong to conversing more human-like. Unfortunately, applying SSML tags can be a daunting task. Jargon makes the experience easy with its built-in SSML editor and simulator. In addition, Jargon catches and reports SSML errors as you edit. When a syntax error is made, Jargon displays an error message informing you to fix the syntax error. As part of this safeguard, a new release cannot be created until all of the conflicts have been resolved, catching issues early and preventing costly iterations later in the development cycle.
Multimodal responses may include media assets such as static images, video or pre-recorded audio. Jargon supports these media assets in the responses. Furthermore, Jargon detects corrupt or missing media asset pointers and validates the assets’ compatibility with each platform’s requirements. These checks can identify incompatibilities before they become issues impacting your customers or preventing your app from being deployed in the first place.
Releasing Content to the Application
Content is hosted by Jargon and delivered to the application via the open-source Jargon Platform SDK. The Jargon Platform SDK allows edits made in Jargon to be released and accessed at runtime. Alternatively, content in Jargon can be downloaded at any time for an offline content release. This removes any run-time dependency on Jargon. Different modes are optimal for different situations and teams have the flexibility to choose either one or a hybrid mode, which involves calling Jargon at run-time but having a local fall-back option, if needed.
Calling Content from the Application
An application with the Jargon Platform SDK implemented can make calls to specific responses in Jargon when triggered by an intent. Use the “application label,” which can be found under the response name in a given response in Jargon, to direct the Jargon Platform SDK to the right response.