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
+22-12Lines changed: 22 additions & 12 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

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

257
257
</div>
258
258
259
-
### Starting a new conversation
259
+
### Starting a new chat
260
260
261
-
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.
261
+
The default approach for users to create a new chat is by using the **New chat** button at the top of the [chat history menu](#using-the-chat-history-menu). The "pen to square" icon is used to identify new chat actions.
262
262
263
-
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.
263
+
<divclass="ws-docs-content-img">
264
+

265
+
</div>
266
+
267
+
Alternatively, you can choose to surface the button as an icon button in the header (using the "pen to square" icon) or as a menu item in the options menu.
268
+
269
+
<divclass="ws-docs-content-img">
270
+

271
+
</div>
272
+
273
+
Each time a user begins a new chat, display a [welcome message, with prompts](#welcome-message) that help them learn what the ChatBot can help with.
264
274
265
275
### Executing user requests
266
276
@@ -272,23 +282,23 @@ This can be done using the [quick response](/extensions/chatbot/messages#message
272
282

273
283
</div>
274
284
275
-
### Using the conversation history menu
285
+
### Using the chat history menu
276
286
277
-
The ChatBot history menu contains a log of a users' previous chats. Clicking the menu icon opens a side drawer in the ChatBot window.
287
+
The chat history menu contains a log of a users' previous ChatBot conversations. Clicking the menu icon opens a side drawer in the ChatBot window.
278
288
279
289
By clicking into the history menu, users can search through previous conversations and perform additional actions, such as sharing a conversation with others.
280
290
281
291
<divclass="ws-docs-content-img">
282
292

283
293
</div>
284
294
285
-
When the conversation history is still loading, display skeleton items:
295
+
When the chat history is still loading, display skeleton items:
286
296
287
297
<divclass="ws-docs-content-img">
288
298

289
299
</div>
290
300
291
-
If there's an error loading the conversation history, display an error screen with steps for resolving the error:
301
+
If there's an error loading the chat history, display an error screen with steps for resolving the error:
292
302
293
303
<divclass="ws-docs-content-img">
294
304

@@ -349,9 +359,9 @@ For guidance, refer to our download transcripts demo, which opens a Markdown fil
349
359
350
360
Choose the download action location that best works for your ChatBot:
351
361
352
-
#### Download via conversation history drawer
362
+
#### Download via chat history drawer
353
363
354
-
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).
364
+
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).
355
365
356
366
<divclass="ws-docs-content-img">
357
367

@@ -367,7 +377,7 @@ To allow users to download individual bot messages, the message actions can incl
367
377
368
378
#### Download control in header
369
379
370
-
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.
380
+
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.
371
381
372
382
<divclass="ws-docs-content-img">
373
383

0 commit comments