AI Writing Assistant
Intro
AI writing assistant quickly and seamlessly edits text in text input fields via provided prompts in a panel, allowing users to refine their input and complete writing tasks with efficiency.
Tapping “Writing Assistant” opens the AI writing assistant panel
Usage
Do
- Use AI writing assistant for repetitive text writing and editing tasks.
- Use AI writing assistant to spark creativity with diverse outputs.
- Use AI writing assistant to enhance and accelerate text iteration and refinement.
Don't
- Don’t use AI writing assistant for non-text editing tasks.
- Don’t use AI writing assistant for customized outputs. Instead, use guided prompts, custom prompts, or Joule.
- Don’t use AI writing assistant where AI-assisted editing adds no value. For example:
- Pre-populated fields with confident AI recommendations
- Unpredictable user intent
- Lack of context or data for high-quality results
- Use an AI notice when there are AI-generated text fields.
- Prioritize value and performance:
- Use the AI writing assistant on text fields that benefit from creative or iterative suggestions.
- Coordinate with your product team to limit AI prompts based on user needs and subscription costs.
- Use a character limit as a parameter for text generation to reduce subscription costs and improve outputs.
Anatomy
A. Entry Point
The “Writing Assistant” button opens the AI writing assistant panel for the selected text input.
B. Text Input Field
Allows the user to enter text, with all text updates made by the AI writing assistant immediately reflected within the input field.
Unless the user selects a portion of the text prior to opening the AI writing assistant, the entire text content will be updated by default.
Updated text is highlighted in blue after each writing assistant edit.
C. Panel Navigation Bar
Includes the “Cancel” and “Done” buttons that allow the user to exit the AI writing assistant without saving or saving any updates.
The version annotation (“Version 2/2”) updates with every text edit.
D. “Undo” and “Redo” Buttons
Allows the user to undo or redo text edits. If there are no previous versions, the “Undo” button is disabled. Similarly, if the user is on the most recent text version, the “Redo” button is disabled.
E. Quick Prompts
Quick prompts immediately update the text within the text field. Icons are optional but must be consistently used and aligned across apps.
F. Prompt Groups
Prompt groups include a list of quick prompts.
G. Feedback
Allows the user to provide feedback for every text enhancement.
AI writing assistant anatomy
Behavior and Interaction
Opening and Exiting AI Writing Assistant
Tapping the “Writing Assistant” button above the keyboard opens the AI writing assistant panel.
If the user hasn’t yet edited the text content using the AI writing assistant, they may immediately close the panel by tapping the “x” button.
User opens AI writing assistant and taps quick prompt to update text
After making the first text update, the panel navigation changes to “Cancel” and “Done.” Tapping “Done” saves the latest text content and closes the AI writing assistant. Tapping “Cancel” prompts the user with a confirmation dialog. The user may continue closing the AI writing assistant, losing any text updates, or choose to keep working.
Tapping ”Cancel” opens a confirmation dialog
Interacting with Elements Outside AI Writing Assistant
The user may scroll behind the AI writing assistant panel. If they tap on another text field or any interactive element behind the panel, they’re prompted by a confirmation dialog.
Text Editing
Tapping a quick prompt immediately updates the text content inside the input field. While the text is updating, the user can’t interact with the AI writing assistant panel.
Tapping a prompt group pushes to a list of quick prompts.
Tapping “Change Tone” pushes to a list of quick prompts
Versioning
Once the user makes their first text edit by tapping a quick prompt, the panel navigation buttons update to “Cancel” and “Done.” The version annotation (“Version 2/2”) also appears below the navigation bar title.
As the user continues to make edits, the version number updates accordingly. Every quick prompt selection leads to a new version.
Tapping quick prompt leads to an updated version
If the user taps “Undo,” reverts to a previous version, and selects another quick prompt, the updated text replaces any subsequent versions.
Tapping “Undo” displays “Version 2/3” and tapping quick prompt leads to new “Version 3/3”
Feedback
Tapping thumbs-up immediately submits positive feedback
Tapping thumbs-down leads to additional feedback options
Variations
Quick Prompts and Prompt Groups
Quick prompts and prompts are customizable. They can also be grouped together as needed in the AI writing assistant panel.
Ensure that accessibility labels and groups are properly considered when customizing the panel layout.
Text Strings
Use concise and self-explanatory text strings for quick prompts and prompt groups.
A quick prompt text string communicates an immediate action that acts upon the text content.
A prompt group text string represents a category of quick prompts that is displayed upon tapping.
Left to right: example panel, placeholder panel
Iconography
A prompt group is always accompanied by a disclosure icon to indicate that there are additional options upon tapping.
A quick prompt icon is optional and visually represents the quick prompt action. When there isn’t a suitable icon for a quick prompt, omit the icon so as not to confuse the user. Quick prompt icons should be used consistently: either pair all quick prompts with icons or omit icons completely. Additionally, where possible, icon usage should be aligned across all SAP applications.
Prompt groups always have a disclosure icon
Pair icons with all quick prompts or omit them completely
Terminology
To ensure a consistent user experience, we recommend using the suggested wording.
Recommended AI UI Text for AI Writing Assistant
For prompts not covered above, apply the following guidelines:
- Use an imperative verb.
- Keep AI action labels as short and clear as possible while prioritizing clarity for users.
- Use the same AI action labels consistently.
Adaptive Design
AI writing assistant in iPad popover
Resources
Development: waTextInput, waResult, waFeedbackResult, waHelperAction
SAP Fiori for Android: AI Writing Assistant
SAP Fiori for Web: AI Writing Assistant