Skip to content

Commit 5ddad01

Browse files
Merge pull request #793 from edonehoo/iss437
docs(design-guidelines): Adds guidelines around starting new chats.
2 parents 918c3f1 + 9c490a1 commit 5ddad01

3 files changed

Lines changed: 99 additions & 11 deletions

File tree

packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import "./images.css"
1616

1717
1. **Container:** The window that contains the entire ChatBot experience and all of its components.
1818
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.
2020
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)).
2121
1. **Messages:** Elements of the conversation between a ChatBot and user. More details can be found in the [message guidelines](#messages).
2222
1. **Attachments:** Details about files that a user has uploaded to the ChatBot.
@@ -43,7 +43,7 @@ import "./images.css"
4343

4444
At the start of a new chat, you should welcome your users to the ChatBot with a greeting.
4545

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:
4747

4848
<div class="ws-docs-content-img">
4949
![Welcome messages.](./img/welcome-message.svg)
@@ -284,11 +284,21 @@ When a ChatBot is launched via an AI-supported action, the action should be sent
284284
![User message in ChatBot for an AI action command.](./img/ai-action-message.svg)
285285
</div>
286286

287-
### Starting a new conversation
287+
### Starting a new chat
288288

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.
290290

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+
<div class="ws-docs-content-img">
294+
![A blue "New chat" button at the top right of a drawer labeled "Chat history".](./img/new-chat-in-nav.svg)
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+
<div class="ws-docs-content-img">
300+
![An icon button is placed at the start of the ChatBot header, prior to a hamburger menu. It contains the visual of a pen placed within a square and is in a hover state, with a darker gray background and a black tooltip that says "New chat."](./img/starting-new-chat.svg)
301+
</div>
292302

293303
### Executing user requests
294304

@@ -300,7 +310,7 @@ This can be done using the [quick response](/extensions/chatbot/messages#message
300310
![Confirmation options from a bot in response to a user's request.](./img/quick-response-confirmation.svg)
301311
</div>
302312

303-
### Using the conversation history menu
313+
### Using the chat history menu
304314

305315
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.
306316

@@ -310,13 +320,13 @@ By clicking into the history menu, users can search through previous conversatio
310320
![Conversation history with an options menu opened on a previous conversation.](./img/conversation-history.svg)
311321
</div>
312322

313-
When the conversation history is still loading, display skeleton items:
323+
When the chat history is still loading, display skeleton items:
314324

315325
<div class="ws-docs-content-img">
316326
![Chat history items loading.](./img/loading-state.svg)
317327
</div>
318328

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:
320330

321331
<div class="ws-docs-content-img">
322332
![Error state in chat history.](./img/error-state.svg)
@@ -377,9 +387,9 @@ For guidance, refer to our download transcripts demo, which opens a Markdown fil
377387

378388
Choose the download action location that best works for your ChatBot:
379389

380-
#### Download via conversation history drawer
390+
#### Download via chat history drawer
381391

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).
383393

384394
<div class="ws-docs-content-img">
385395
![Expanded menu for previous chat in the history window, which shows a download option.](./img/download-chat-history.svg)
@@ -395,7 +405,7 @@ To allow users to download individual bot messages, the message actions can incl
395405

396406
#### Download control in header
397407

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.
399409

400410
<div class="ws-docs-content-img">
401411
![Download transcript action within the ChatBot header options menu.](./img/download-header.svg)

0 commit comments

Comments
 (0)