Table of Contents
Configure Custom System Prompt
Learn how to configure custom system prompts in YakShaver to tailor AI-generated PBIs to your team's requirements.
Configure System Custom Prompt in YakShaver Portal
YakShaver supports custom system prompts for PBI generation, allowing you to customize AI-generated content to match your team's specific requirements.
Follow these steps to configure custom system prompts:
Prerequisites
You need admin permissions for your tenant. Only admin accounts can edit custom system prompts.
Accessing the Portal
Access the YakShaver portal using one of these methods:
- Clicking the "Portal" button in the top-right corner on the yakshaver.ai home page
- Or directly visiting https://portal.yakshaver.ai/
Figure: Access the YakShaver portal from the home page
Configuration Levels
YakShaver supports two configuration levels for custom prompts: tenant level and project level.
Tenant Level Configuration
Tenant level prompts apply to all projects under the current tenant. All tenants start with the YakShaver default prompt:
PBI Title:
If bug → "🐛 Bug - {{DESCRIPTION}}"
If feature/change →
- "✨ {{FEATURE_NAME}} - {{DESCRIPTION}}" if a feature name can be extracted and differs from the description
- "✨ {{DESCRIPTION}}" if no feature name can be extracted or it’s the same as the description
Feature name rules:
- Extract core feature from description
- Max 2 words, no extra actions
- Remove filler words like "feature", "module", "component"
- Description should describe the change, not repeat the feature name
Admins can view and edit this prompt in the Tenant Prompt Configuration card on the System Info page.
Figure: Edit tenant level prompt configuration
Project Level Configuration
⚠️ Note: Setting a project-level prompt will override the tenant-level prompt for the project.
Admins can set this by opening a project and editing the Custom System Prompt field.
Figure: Edit project level prompt configuration
Regular users can view each project's prompt in the project list page.
Figure: View project level prompts in the project list
Example: Language Customization
Here's a practical example of how custom system prompts can be used to customize YakShaver's output.
Consider a Chinese-speaking team using YakShaver, where the default PBI language for YakShaver is English. You can configure a tenant level system prompt to ensure all projects generate Chinese PBIs.
Figure: Setting up Chinese language prompt at tenant level
With this configuration, YakShaver will generate Chinese PBIs regardless of the video recording language.
Figure: Generated PBI in Chinese language
Custom system prompts can also configure various aspects of PBI generation, including format, language, tone, and style.
⚠️ Important: Use custom system prompts carefully. Results may vary and may not always meet expectations.