bytechef
bytechef copied to clipboard
Improve naming in technical files to help AI to produce cheaper and better answers
We have doubt should we rename technical names for task structure elements. When inside workflow definition YAML/JSON we found out cognitive pressure to properly relate:
- meaning of element
task.label- should it be title as it would show up in UI as task title? (label is universal abstract notion used for peace of text attached to something while title is much more it is the text that would be emphasised for the purpose of distinguishment - meaning of
task.parameters- definetely those aretask.properties- in the case of task of typebash/v1/executescriptis not parameter ofbash/v1/executecomponent, contrary it is component's property for which flow designer provides parameter for. In interaction with AI we spotted this issue. AI had figured out wrong how to assemble task. task.name- OK - this one is hard... is name good orkeyorreferenceshould be used? It is important to understand that defined name value is used later in subsequent tasks to access particular task output. So should it bekey,reference,accessorReference,accessName,referenceName? All comments welcome.