You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ import "./images.css"
16
16
17
17
1.**Container:** The window that contains the entire ChatBot experience and all of its components.
18
18
1.**Header:** A persistent region at the top of the ChatBot window that contains navigation, branding, and actions.
19
-
1.**History menu:** A menu that contains a conversation history of previous chats.
19
+
1.**Chat history menu:** A menu that contains a history of previous chats.
20
20
1.**Options menu:** A menu that contains settings that are relevant to your product. This typically includes display options (more details in the [ChatBot variations section](#variations)) and other general settings (more details in the [ChatBot settings and preferences section](#chatbot-settings-and-preferences)).
21
21
1.**Messages:** Elements of the conversation between a ChatBot and user. More details can be found in the [message guidelines](#messages).
22
22
1.**Attachments:** Details about files that a user has uploaded to the ChatBot.
@@ -43,7 +43,7 @@ import "./images.css"
43
43
44
44
At the start of a new chat, you should welcome your users to the ChatBot with a greeting.
45
45
46
-
If you have user details from their account information, you can personalize this greeting with their username or name. If you don't have this information, or if you'd prefer to not use their personal details, you should instead introduce the ChatBot:
46
+
As much as possible, the suggested prompts should consider the user’s location in the service or application, or the situation their project is undergoing. If you have user details from their account information, you can personalize this greeting with their username or name. If you don't have this information, or if you'd prefer to not use their personal details, you should instead introduce the ChatBot:
47
47
48
48
<divclass="ws-docs-content-img">
49
49

@@ -284,11 +284,21 @@ When a ChatBot is launched via an AI-supported action, the action should be sent
284
284

285
285
</div>
286
286
287
-
### Starting a new conversation
287
+
### Starting a new chat
288
288
289
-
Each time a user begins a new conversation, display a [welcome message, with prompts](#welcome-message)that help them learn what the ChatBot can help with.
289
+
Each time a user begins a new chat, display a [welcome message](#welcome-message), with prompts that provide initial suggestions and indicate the actions that the ChatBot can take.
290
290
291
-
As much as possible, the suggested prompts should consider the user’s location in the service or application, or the situation their project is undergoing.
291
+
The default approach for users to create a new chat is by clicking the "New chat" button (which contains a "pen to square" icon) placed at the top of the [chat history menu](#using-the-chat-history-menu).
292
+
293
+
<divclass="ws-docs-content-img">
294
+

295
+
</div>
296
+
297
+
Alternatively, you can choose to surface the "New chat" button as an icon button in the header. For this approach, the "pen to square" icon is displayed in the button and a "New chat" tooltip should appear on hover and focus.
298
+
299
+
<divclass="ws-docs-content-img">
300
+

301
+
</div>
292
302
293
303
### Executing user requests
294
304
@@ -300,7 +310,7 @@ This can be done using the [quick response](/extensions/chatbot/messages#message
300
310

301
311
</div>
302
312
303
-
### Using the conversation history menu
313
+
### Using the chat history menu
304
314
305
315
The ChatBot history menu contains a log of a user's previous chats. Clicking the menu icon opens a side drawer in the ChatBot window.
306
316
@@ -310,13 +320,13 @@ By clicking into the history menu, users can search through previous conversatio
310
320

311
321
</div>
312
322
313
-
When the conversation history is still loading, display skeleton items:
323
+
When the chat history is still loading, display skeleton items:
314
324
315
325
<divclass="ws-docs-content-img">
316
326

317
327
</div>
318
328
319
-
If there's an error loading the conversation history, display an error screen with steps for resolving the error:
329
+
If there's an error loading the chat history, display an error screen with steps for resolving the error:
320
330
321
331
<divclass="ws-docs-content-img">
322
332

@@ -377,9 +387,9 @@ For guidance, refer to our download transcripts demo, which opens a Markdown fil
377
387
378
388
Choose the download action location that best works for your ChatBot:
379
389
380
-
#### Download via conversation history drawer
390
+
#### Download via chat history drawer
381
391
382
-
If your ChatBot uses a conversation history drawer, you can provide a download option in the [actions menu linked to a previous conversation](/extensions/chatbot/ui#drawer-with-conversation-actions).
392
+
If your ChatBot uses a chat history drawer, you can provide a download option in the [actions menu linked to a previous conversation](/extensions/chatbot/ui#drawer-with-conversation-actions).
383
393
384
394
<divclass="ws-docs-content-img">
385
395

@@ -395,7 +405,7 @@ To allow users to download individual bot messages, the message actions can incl
395
405
396
406
#### Download control in header
397
407
398
-
If you don't use a conversation history drawer, you can place an option to download the transcript for the active chat within the header options menu.
408
+
If you don't use a chat history drawer, you can place an option to download the transcript for the active chat within the header options menu.
399
409
400
410
<divclass="ws-docs-content-img">
401
411

0 commit comments