AI-Generated Knowledge Base Articles

Learn how to use ProductLift's AI to automatically generate knowledge base articles from your changelog entries, saving time while creating comprehensive documentation for your users.

What is AI Knowledge Base Generation?

AI Knowledge Base Generation transforms your changelog entries into comprehensive help articles. When you release a new feature or update, you can automatically generate documentation that explains how to use it, troubleshoot common issues, and get the most value from the change.

Benefits:

  • Turn announcements into documentation with one click
  • Maintain consistency between changelog and knowledge base
  • Save hours of documentation writing time
  • Ensure new features are always documented

When to Use AI Generation

Use AI generation for:

  • New feature releases that need documentation
  • Updates that change how existing features work
  • Quick documentation for smaller improvements
  • Getting started on complex articles (then edit manually)

Consider manual writing for:

  • Highly technical documentation requiring precision
  • Articles with specific screenshots or step-by-step flows
  • Content that needs your unique brand voice
  • Complex topics that need careful structuring

Best approach: Use AI to generate a first draft, then edit and enhance with screenshots, examples, and brand-specific language.

Generating an Article from Changelog

Step 1: Navigate to a Changelog Entry

  1. Go to your Changelog board
  2. Find the published changelog entry you want to document
  3. Open the entry's detail view

Step 2: Generate Knowledge Base Article

  1. Look for the "Generate KB Article" or AI generation button
  2. Optionally provide a custom prompt to guide the AI
  3. Click to generate

The AI will:

  • Analyze your changelog entry content
  • Create a comprehensive article title
  • Generate structured content with headers and sections
  • Automatically select the most appropriate knowledge base section

[Screenshot: Changelog entry with "Generate KB Article" button highlighted]

Step 3: Review and Edit

After generation:

  1. Review the generated title and content
  2. Edit as needed to add:
    • Screenshots or images
    • Specific examples
    • Additional context
    • Brand-specific language
  3. Verify the selected section is appropriate
  4. Save or publish the article

[Screenshot: Generated article preview with edit options]

Custom Prompts

You can provide custom instructions to guide the AI's output.

Using Custom Prompts

When generating, enter a custom prompt to:

  • Focus on specific aspects of the feature
  • Adjust the tone or style
  • Request specific sections or content
  • Target a particular audience

Example Prompts:

Focus on setup steps for first-time users

Include troubleshooting tips for common issues

Write for technical users who want API integration details

Create a quick start guide format

Include comparison with the old way of doing this

When Custom Prompts Help

  • The changelog entry is brief but the feature is complex
  • You want documentation from a specific angle
  • The default output needs a different structure
  • You're targeting a specific user segment

AI-Generated Content Format

The AI generates content based on your portal's editor settings:

WYSIWYG Editor:

  • HTML formatting
  • Headers (H2-H6)
  • Bold and italic text
  • Ordered and unordered lists
  • Clean, renderable HTML

Markdown Editor:

  • Markdown formatting
  • ## and ### headers
  • **bold** and *italic*
  • - list items
  • Standard markdown syntax

The AI matches your editor type automatically for seamless editing.

Section Assignment

When generating an article, the AI:

  1. Analyzes your changelog content
  2. Reviews your existing knowledge base sections
  3. Suggests the most appropriate section
  4. You can override the suggestion if needed

Manual Section Override

If the AI's section choice isn't right:

  1. Review the suggested section before saving
  2. Select a different section from the dropdown
  3. Or create a new section for the article

Improving Section Suggestions

For better AI section matching:

  • Use clear, descriptive section titles
  • Add descriptions to your sections
  • Organize sections by topic/feature area

AI Credits

Knowledge base article generation uses AI credits from your account.

Credit Usage:

  • 1 AI credit per article generated
  • Regenerating uses an additional credit

Check Balance:

  • View remaining credits in Settings → Account
  • Credits refresh monthly based on your plan

Out of Credits:

  • Wait for monthly refresh
  • Purchase additional credits
  • Write articles manually

Best Practices

Provide Good Source Content

The AI works best with detailed changelog entries:

Good changelog entry:

Dark Mode Support

We've added a new dark mode option to make working at night easier
on your eyes. You can switch between light, dark, or system preference
in Settings → Branding. Dark mode works across all pages including
dashboards, reports, and the mobile app.

Poor changelog entry:

Added dark mode

Better source content produces better articles.

Review and Enhance

Always review AI-generated articles:

  1. Check accuracy: Verify all information is correct
  2. Add visuals: Include screenshots where helpful
  3. Improve examples: Add real-world use cases
  4. Enhance structure: Reorganize if needed
  5. Brand voice: Adjust tone to match your style

Link Related Content

After publishing:

  • Link to related articles
  • Update existing articles to reference the new one
  • Add the article to relevant collections or guides

Troubleshooting

Issue: AI Response Error

Solution:

  • Verify you have AI credits available
  • Check that the changelog entry has content
  • Try again - occasional API timeouts can occur

Issue: Generated Content Too Generic

Solution:

  • Use a custom prompt with specific instructions
  • Ensure your changelog entry has detailed content
  • Edit the generated content to add specifics

Issue: Wrong Section Selected

Solution:

  • Override the section selection manually
  • Improve section titles and descriptions
  • Consider if you need a new section

Issue: Format Doesn't Match Editor

Solution:

  • The format should auto-match your portal's editor type
  • If mismatched, convert manually or regenerate
  • Check your portal's editor setting in Settings