botframework-sdk icon indicating copy to clipboard operation
botframework-sdk copied to clipboard

Composer uses terms which do not align with the documentation of the core SDK.

Open tomlm opened this issue 4 years ago • 1 comments

Describe the bug

Composer continues to use terms and descriptions which do not match the SDK and documentation of the components. This leads to cognitive load in a system which is already extremely complex.

First Principal - Composer should always surface the actual name that is in the docs, in the SDK and in the class names. Not doing that leads to confusion and insconsistencies.

Examples:

  • "Greeting" --> Currently called Greeting. It's not a greeting trigger. It should be OnConversationUpdate. That's when the trigger happens, when someone joins or leaves a conversation.
  • "Connect to a skill" -> BeginSkillDialog This is a dialog. Knowing it acts like a dialog is IMPORTANT.
  • "Send Handoff Event" -> this is not an event, it's an activity. Knowing that it's an activity is important because it gets sent someplace. Events are internal to the dialog stack. These names actually matter and being loose with them does the exact opposite of what you think you are doing. It's adding cognitive load to the person who reads about our system and how it works.

It's OK to have human descriptions of these things, but they should be "after" the actual physical name of the thing, and they should be accurate and enhance knowledge, not over-simplifications which muddy the waters.

Version

1.4

tomlm avatar Apr 16 '21 01:04 tomlm

This requires changes to the component uischema/schemas. What is implemented is the design spec, so please work with @mareekuh and team when updating.

@tomlm, the design goal was to make a complex and confusing system less complex with abstraction as well as a calibration/reconciliation of terms similar to PVA in addition to being authentic to the dialog system. What you see today is a mix of the two principles.

cwhitten avatar Apr 16 '21 01:04 cwhitten