Getting Started
This guide will walk you through setting up PromptCompose and creating your first project, prompt, and A/B test.
Prerequisites
Before you begin, ensure you have:
- A modern web browser (Chrome, Firefox, Safari, Edge)
- An internet connection for API access
- Basic understanding of AI prompts and variables
Account Setup
1. Create Your Account
- Navigate to the PromptCompose application
- Click “Sign Up” on the login page
- Choose your registration method:
- Email/Password: Enter your details and verify via email
- Google: Sign up with your Google account
- Microsoft: Sign up with your Microsoft account
2. Email Verification
If you signed up with email/password:
- Check your email inbox for a verification code
- Enter the 6-digit code in the verification page
- Click “Verify Account” to complete setup
3. First Login
- Go to the login page
- Enter your credentials or use your chosen provider
- You’ll be redirected to create your first project
Creating Your First Project
1. Project Setup
When you first log in, you’ll see the “Create Your First Project” screen:
- Project Name: Enter a descriptive name (e.g., “Marketing Campaigns”)
- Description: Provide a brief description of the project’s purpose
- Tags: Add relevant tags for organization (optional)
- Click “Create Project”
2. Project Dashboard
After creating your project, you’ll land on the dashboard which shows:
- Resource counts (0 for new projects)
- Quick creation buttons
- Recently updated items (empty for new projects)
- Active A/B tests section
Creating Your First Prompt
1. Navigate to Prompts
- Click “Prompts” in the sidebar
- Click “Create Prompt” button
2. Prompt Creation
- Name: Give your prompt a descriptive name
- Content: Write your prompt in the Monaco Editor
You are a helpful assistant. Please help the user with their {task} by providing {detail_level} information.
- Variables: Define variables used in your prompt:
- task: Text field, required
- detail_level: Select field with options like “basic”, “detailed”, “comprehensive”
3. Deploy Your Prompt
- Click “Deploy”
- Enter a deployment message describing the changes
- Add tags if needed
- Click “Deploy Version”
Your prompt is now live and ready to use!
Working with Variables
1. Create a Variable Group
- Navigate to “Variable Groups”
- Click “Create Variable Group”
- Name: “Common Variables”
- Add variables:
- user_name: Text, required
- language: Select with options [“English”, “Spanish”, “French”]
- tone: Select with options [“Professional”, “Casual”, “Friendly”]
2. Use Variables in Prompts
When creating prompts, reference variables with double curly braces:
Hello {user_name}, I'll help you in {language} with a {tone} approach.
Creating Templates
1. Template Creation
- Go to “Templates”
- Click “Create Template”
- Name: “Customer Support Template”
- Content:
You are a {company_name} customer support representative. Help the customer with their {issue_type} in a {tone} manner. Customer inquiry: {customer_message}
- Define template variables
- Click “Save Template”
2. Create Prompt from Template
- From the templates list, click on your template
- Click “Create Prompt”
- The template content and variables are pre-filled
- Customize as needed and deploy
Setting Up A/B Testing
1. Create Your First A/B Test
- Navigate to “A/B Testing”
- Click “Create A/B Test”
2. Test Configuration
General Information:
- Name: “Welcome Message Optimization”
- Description: “Testing different welcome messages for user engagement”
- Start Date: Today
- End Date: Two weeks from today
Variants:
- Control (50%): Your original prompt
- Variant A (25%): Modified version 1
- Variant B (25%): Modified version 2
Strategy:
- Choose “Weighted” for automatic distribution
- Set the percentages as shown above
3. Launch Your Test
- Review all settings
- Click “Create Test”
- The test status will be “Active”
- Monitor performance on the dashboard
API Integration
1. Generate API Key
- Go to “Integrations”
- Click “Create API Key”
- Enter a descriptive name: “Production App”
- Copy the generated key immediately (you won’t see it again)
2. Next Steps for Developers
Once you have your API key:
- Install the PromptCompose SDK
- Follow the SDK Getting Started Guide
- Explore SDK Examples
Navigation Tips
Sidebar Navigation
- Dashboard: Overview of all resources
- Prompts: Create and manage prompts
- Templates: Reusable prompt structures
- Variable Groups: Centralized variable management
- A/B Testing: Optimization experiments
- Integrations: API keys and SDK setup
- Settings: User and project settings
Project Switching
- Click the project dropdown in the top navigation
- Select a different project or click “View All Projects”
- Create new projects from the projects page
Global Search
- Click the search icon or use the search bar
- Type to search across all resources
- Click on results to navigate directly to items
Best Practices
Prompt Organization
- Use descriptive names: “Customer Support - Order Issues” vs “Prompt1”
- Add meaningful tags: “customer-service”, “email”, “urgent”
- Document deployments: Always include deployment messages
- Version carefully: Test prompts before deploying to production
Variable Management
- Group related variables: Create variable groups for common use cases
- Use validation: Set required fields and type validation
- Consistent naming: Use clear, descriptive variable names
- Default values: Provide sensible defaults where possible
A/B Testing
- Clear hypotheses: Know what you’re testing and why
- Sufficient sample size: Run tests long enough for statistical significance
- One change at a time: Test single variables to isolate impact
- Document results: Record learnings for future reference
Next Steps
Now that you’ve set up PromptCompose:
-
Explore Features: Check out our detailed feature guides:
-
Set Up Team Collaboration:
-
Integrate with Your Applications:
Need Help?
- Feature Guides: Browse our detailed platform documentation
- Troubleshooting: Check our troubleshooting guide
- FAQ: See frequently asked questions
- Support: Contact our team for assistance
Congratulations! You’re now ready to start managing your AI prompts with PromptCompose. Continue with our detailed feature guides to discover the full power of the platform.