-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(ux-writing): Adds conversation design and chatbot guidelines. #4206
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
1e032d0
docs(chatbots): Adds chatbot design guidelines.
edonehoo 0e8219b
docs(ux-writing): Adds conversation design and chatbot guidelines.
edonehoo 0f47a3b
Merge branch 'v6' into iss4001
edonehoo 6ecaaf0
File restructuring and small edits.
edonehoo 6485a29
Merge branch 'v6' into iss4001
edonehoo 3866c4f
Merge branch 'main' into iss4001
edonehoo 554fb85
Updates content to align with incoming chatbot extension.
edonehoo 9498897
Merge branch 'main' into iss4001
edonehoo b575bf2
Apply suggestions from code review
edonehoo 8ae6730
Removes unused files.
edonehoo 8625cea
Fix link to chatbot page
edonehoo baf4c0c
Fixing some typos
edonehoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
75 changes: 75 additions & 0 deletions
75
...atternfly-docs/content/PatternFly-AI/conversation-design/conversation-design.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
id: Conversation design | ||
section: PatternFly-AI | ||
--- | ||
|
||
import { Button, Flex, FlexItem } from '@patternfly/react-core'; | ||
import ArrowRightIcon from '@patternfly/react-icons/dist/esm/icons/arrow-right-icon'; | ||
|
||
|
||
# Conversation design guidelines | ||
|
||
**Conversation design** is a method of writing for conversational interfaces, like chatbots or voicebots. The goal of conversation design is to create an interactive experience that resembles human-to-human conversation as much as possible. Like traditional content design, conversation design is focused on using words to make experiences clear, concise, and well-timed. | ||
|
||
Good conversation design combines content strategy, writing, and design to ensure that the development and use of chatbots is centered on real user needs. This includes making sure that all text related to the conversational UI supports easy engagement with chatbots, while staying aligned with brand standards. | ||
|
||
When designing AI conversations alongside PatternFly-based projects, it is important to align with our established [brand voice and tone](/ux-writing/brand-voice-and-tone), as well as our [ethical guidelines for AI.](/patternfly-ai/ai-guidelines) | ||
rebeccaalpert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Best practices | ||
|
||
Following these best practices to help ensure that your users can complete their goals through an AI-based conversation: | ||
|
||
- Be transparent about AI use. | ||
- Be direct, brief, and consistent. | ||
- Frame questions in terms of value for the user. | ||
- If you ask for personal info, tell users "why" you're asking first. | ||
- Always have the last word. | ||
|
||
## Writing for chatbots | ||
|
||
When chatbots are designed to meet the needs of your users, they can improve the overall UX of your product. They are convenient, efficient, and persistent. | ||
|
||
[Our chatbot extension](/patternfly-ai/chatbot/about-chatbot) utilizes PatternFly components to create a foundation for an AI-based chatbot, with additional customization options. | ||
|
||
<Flex> | ||
<FlexItem> | ||
<Button component="a" href="/patternfly-ai/chatbot/about-chatbot" target="_blank" variant="primary" size="lg">Use the chatbot extension <ArrowRightIcon /></Button> | ||
</FlexItem> | ||
</Flex> | ||
|
||
Chatbots are only as good as the writing that goes into them. The language they use must build trust, clearly establish the “rules” of the conversation, and support users' goals. | ||
|
||
In addition to general microcopy, like headings or buttons, you will need to write: | ||
- Welcome and goodbye messages. | ||
- Bot prompts. | ||
- AI disclosures. | ||
|
||
### Welcome and goodbye messages | ||
|
||
It is important to always welcome users to the chatbot experience, and (if applicable) to say goodbye when they've ended the chat. A goodbye message isn't always necessary, like in instances where users can "minimize" a chat window to come back to it later. | ||
|
||
When you know your user's name, address them directly. | ||
|
||
![Chatbot welcome message with user's name](./img/chatbot-welcome.png) | ||
|
||
### Bot prompts | ||
|
||
When writing your bot's prompts: | ||
|
||
- Keep messages short and simple. Try to stick to 3 lines of text in a message and only send 3 messages at most before allowing a user to provide input. | ||
- Be direct and limit choices for users as much as possible. | ||
- Unlike traditional content design, *don't lead with the benefit.* End with the benefit to be sure that it's read and acted upon. Users should be able to complete an action solely based on a chatbot's last sentence. | ||
- Frame any questions from the bot in terms of value for the user. | ||
- Provide examples when relevant. | ||
- Avoid open-ended questions. If you ask any, make them very simple, increase pause time between messages, and tell users when they should type. | ||
- Utilize different methods of presenting information, like cards or buttons. You don't have to always use plain text in your messages; sometimes different message types can be more convenient and engaging. | ||
|
||
![Chatbot prompt examples](./img/chatbot-prompts.png) | ||
|
||
### AI disclosure | ||
|
||
Make sure to disclose any use of AI in chatbots. Our users should be able to trust that we are honest and transparent with them as much as possible. | ||
|
||
- Use labels and other visual styling cues to clearly identify AI features. | ||
- Add necessary legal disclosures where you can, like in the chatbot footer. | ||
- Display an indicator when the bot is "thinking" or "typing," so that users know to expect feedback. |
Binary file added
BIN
+165 KB
...tternfly-docs/content/PatternFly-AI/conversation-design/img/chatbot-prompts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+148 KB
...tternfly-docs/content/PatternFly-AI/conversation-design/img/chatbot-welcome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which sections do we want this and the chatbots.md files to appear in the nav? Should they be under patternfly-ai/conversation-design as different tabs?
if so, i think you should be able to do that by using