Adjust GLQL Syntax Based on Research Outcomes
What is this Issue about:
A Solution Validation was conducted to determine if the existing state of the GLQL syntax was the one we should carry forward to Beta and subsequently GA. This is not something we can change after Beta so it was important to understand if the current syntax met users opinions.
Research findings:
Research indicated we should adjust the syntax to the following:
YAML only, with <code data-sourcepos="9:19-9:24">query:</code> being a mandatory property.
Insights for this decision can be viewed here.
As @afracazo notes here, feedback strongly supports the adoption of a syntax similar to Option 2 due to its simplicity, readability, and alignment with plain English.
As noted <em data-sourcepos="15:13-15:18">here</em>:
Option 2 was the preferred
🏆 (Dovetail videos)Option 2 stood out as the least cluttered and most straightforward. It was preferred by users for its alignment with plain language and intuitive structure
- Some participants preferred SQL-style syntax (Option 3) due to familiarity but acknowledged it could be confusing for less technical users.
Using simple, everyday language makes the syntax easier to learn (dovetail videos)
Using simple, everyday language helps participants understand the syntax better. Plain english avoids coding terminology, making it intuitive for a more all-around audience