AI Assistant Guide - Powered by ChatGPT

Complete guide to using ChangeCrab's AI assistant to create, tune, and optimize your changelog entries.

All Articles

AI Assistant Guide - Powered by ChatGPT

ChangeCrab's AI Assistant uses ChatGPT 4o-mini to help you create professional, engaging changelog entries. This premium feature can save you hours of writing time while improving the quality of your release notes.

Prerequisites

To use the AI Assistant, you need:

  • A premium ChangeCrab subscription
  • Available AI credits (50 credits per month)
  • Access to the changelog editor

Accessing the AI Assistant

The AI Assistant is available in the changelog editor:

  1. Open your changelog editor
  2. Click the "AI" button in the toolbar (shows remaining credits)
  3. The AI Assistant modal will open

AI Actions Available

1. Build a Changelog from This Info

Transform basic notes or bullet points into a complete, well-structured changelog entry.

When to use: When you have rough notes about changes and want a polished entry.

Example input: 

New dashboard
Added analytics charts
Better performance
Fixed login bug

What you get: A complete changelog entry with proper formatting, clear descriptions, and professional language.

2. Tune for [Audience]

Optimize your content for specific audiences:

  • Developers - Technical details, API changes, breaking changes
  • Marketing - User benefits, feature highlights, engaging language
  • Customers - User-friendly explanations, benefits, upgrade instructions
  • Stakeholders - Business impact, strategic value, market positioning

When to use: When you have content but need to adapt it for a specific audience.

3. Change Tone to [Style]

Adjust the writing style to match your brand voice:

  • Professional - Corporate, formal, business-focused
  • Casual - Friendly, approachable, conversational
  • Enthusiastic - Exciting, engaging, feature-highlighting
  • Technical - Detailed, precise, developer-oriented
  • Simple - Clear, straightforward, easy to understand

When to use: When you have content but want to adjust the tone to match your brand.

4. Safety Check

Review content for security, legal, and privacy issues before publishing.

When to use: Before publishing sensitive information or when you want to ensure compliance.

What it checks:

  • Security vulnerabilities mentioned
  • Legal compliance issues
  • Privacy concerns
  • Potentially sensitive information

Credit System

The AI Assistant uses a credit-based system:

  • 50 credits per month for premium users
  • 1 credit per AI operation
  • Monthly reset on the 1st of each month
  • No rollover - unused credits expire

Your remaining credits are displayed in the AI button. Use them wisely!

Step-by-Step Usage

Using "Build" Action

  1. Click the AI button in the editor
  2. Select "Build a changelog from this info"
  3. Enter your notes or bullet points in the input field
  4. Click "Generate"
  5. Review the generated content
  6. Click "Apply" to insert it into your editor, or "Regenerate" to try again

Using "Tune" Action

  1. Write or paste your existing content in the editor
  2. Select the content you want to tune
  3. Click the AI button
  4. Select "Tune for [audience]" and choose your audience
  5. Click "Generate"
  6. Review and apply the tuned content

Using "Change Tone" Action

  1. Select the content you want to modify
  2. Click the AI button
  3. Select "Change tone to [style]" and choose your desired tone
  4. Click "Generate"
  5. Review and apply the modified content

Best Practices

Getting Better Results

  • Provide Context - Include relevant details about the change
  • Be Specific - More specific input leads to better output
  • Review and Edit - Always review AI-generated content before publishing
  • Combine with Manual Editing - Use AI as a starting point, then refine
  • Use Multiple Actions - Build first, then tune for audience, then adjust tone

Input Tips

  • Include key features and benefits
  • Mention technical details if relevant
  • Specify the target audience
  • Include any important warnings or breaking changes
  • Provide examples or use cases when helpful

Limitations

Keep in mind:

  • AI-generated content should always be reviewed by humans
  • Technical accuracy should be verified
  • Brand voice may need adjustment
  • Some content may require domain-specific knowledge
  • Credit limits apply (50 per month)

Troubleshooting

AI Button Not Showing

If you don't see the AI button:

  • Verify you have a premium subscription
  • Check that you're in the changelog editor
  • Refresh the page
  • Contact support if issues persist

Out of Credits

If you've used all your credits:

  • Wait until the 1st of next month for reset
  • Use credits more selectively
  • Consider manual writing for some entries

Poor Quality Results

If results aren't good:

  • Provide more context in your input
  • Try different actions (Build vs Tune)
  • Regenerate to get different results
  • Manually edit the generated content

Next Steps

Now that you know how to use the AI Assistant: