Guide 1.15 — Maintenance, Updates and Version Management
Product: SmartDescribe Pro
Publisher: Cazgrae
Platform: WordPress and WooCommerce
1. Introduction
Keeping SmartDescribe Pro up to date helps maintain a reliable workflow for generating and managing image alt text across your WooCommerce store.
SmartDescribe Pro operates within a wider WordPress environment that includes WooCommerce, your theme, other plugins, your hosting configuration, and your selected AI provider. Changes to any of these components can affect how your website operates.
This guide explains how to maintain SmartDescribe Pro, prepare for updates, check compatibility, protect your existing data, and troubleshoot problems following an update.
The goal is to keep your installation secure and reliable while minimising disruption to your online store.
2. Checking Your Installed Version
Before updating SmartDescribe Pro or requesting support, identify the version currently installed.
How to check the version
- Sign in to your WordPress administration dashboard.
- Navigate to Plugins → Installed Plugins.
- Locate SmartDescribe Pro.
- Check the version information displayed beneath the plugin name.
Depending on your installed release, version information may also appear within the plugin’s administration area.
Why version information matters
Knowing your installed version helps you:
- Confirm whether you are running the expected release.
- Identify whether an update is available.
- Check whether a particular feature should be present.
- Compare installations when investigating a problem.
- Provide useful information when contacting support.
When reporting an issue, include your SmartDescribe Pro version, WordPress version, and WooCommerce version.
3. Why Plugin Updates Matter
Updates may introduce new features, improve existing functionality, correct defects, address security issues, or improve compatibility.
The changes included in an update depend on the specific release.
Potential improvements include:
- Bug fixes.
- Security improvements.
- Compatibility updates.
- Changes to AI provider integrations.
- Improvements to individual product optimisation.
- Improvements to bulk processing.
- Changes to scheduling or automation.
- Updates to administration screens.
- Improvements to error handling and reporting.
Always consult the release notes supplied with the version you intend to install.
Do not assume that every update contains every type of improvement. Use the release information to understand what has actually changed.
4. Preparing Before an Update
A little preparation can prevent unnecessary disruption.
Step 1: Confirm that the current installation works
Check that SmartDescribe Pro is active and that its main functions are operating normally.
If you already have an unresolved error, record it before updating. This will help you distinguish an existing problem from a new issue.
Step 2: Review the release information
Read the available update notes and check for changes affecting:
- Supported WordPress versions.
- WooCommerce compatibility.
- PHP requirements.
- AI provider connections.
- API configuration.
- Individual optimisation.
- Bulk processing.
- Scheduled tasks.
- History and undo functionality.
- Settings and stored information.
Only rely on compatibility and feature information confirmed for the specific release.
Step 3: Create a backup
Before a significant update, ensure you have a recent, reliable backup.
Your backup arrangements should account for the WordPress database and website files.
Store the backup securely and understand how to restore it if necessary.
Step 4: Choose an appropriate time
For a busy online store, schedule significant maintenance during a quieter period.
Avoid making major changes immediately before a promotion, product launch, or important sales event.
Step 5: Consider using a staging site
If your hosting provider offers a staging environment, test significant updates there before applying them to your live website.
This is particularly useful when your store relies on multiple plugins or has a large product catalogue.
5. Updating SmartDescribe Pro
The correct update procedure depends on how your version is distributed.
Method A: Updating through WordPress
If WordPress offers an update for SmartDescribe Pro:
- Sign in to WordPress as an administrator.
- Open Dashboard → Updates or Plugins → Installed Plugins.
- Locate the available SmartDescribe Pro update.
- Review the release information.
- Confirm that an appropriate backup is available.
- Start the update using the available WordPress controls.
- Wait for the process to finish.
- Confirm that SmartDescribe Pro remains active.
- Open the plugin’s administration area.
- Perform the post-update checks described in this guide.
Method B: Updating with a supplied ZIP file
If Cazgrae supplies a new plugin ZIP file, follow the installation instructions accompanying that release.
Before replacing an existing installation, confirm the supported update procedure.
Do not delete your existing plugin or manually overwrite its files unless the release instructions explicitly require that method.
An incorrect replacement procedure may cause downtime or leave the plugin installation incomplete.
After the update
A successful installation message does not necessarily mean every function is working correctly.
Check the plugin’s configuration and test the functions your store depends on.
6. Post-Update Testing
After updating SmartDescribe Pro, perform a few basic checks.
General checks
- SmartDescribe Pro remains active.
- The administration pages open correctly.
- The expected settings are available.
- Your selected AI provider remains configured.
- The API connection works, where a test function is available.
- Individual optimisation works.
- Bulk processing works, if you use it.
- Scheduled optimisation works, if supported and enabled.
- History or undo functions work, if available.
- WooCommerce product editing continues to work.
- Your public-facing website operates normally.
The amount of testing required depends on the scope of the update and the features you use.
Test one product first
Before launching a large optimisation job:
- Open a suitable WooCommerce product.
- Run an individual optimisation task.
- Review the generated alt text.
- Confirm that the result is saved correctly.
- Check the relevant product page.
This simple test can reveal problems before they affect a large number of products.
7. Protecting Your Settings and Existing Alt Text
Your plugin configuration and product content are important parts of your store.
Although updates are generally intended to preserve existing functionality, the precise behaviour depends on the release.
Before updating
Make a secure record of important configuration details, including:
- Selected AI provider.
- Relevant optimisation settings.
- Writing tone or template selections, where available.
- Scheduling preferences, where available.
- Other settings that are important to your workflow.
Never store API keys in unsecured documents or ordinary maintenance notes.
After updating
Confirm that your settings remain correct.
If a setting appears to be missing, check whether it has moved, been renamed, or changed as part of the update before recreating the configuration.
Protecting existing alt text
Before running a bulk operation after an update, review the available controls for handling existing descriptions.
Test the behaviour on a small selection of products and verify the results.
Do not reprocess your entire catalogue automatically just because the plugin has been updated.
If existing descriptions are already accurate and useful, unnecessary reprocessing may waste time and AI provider resources.
8. WordPress, WooCommerce and PHP Compatibility
SmartDescribe Pro operates within your wider website environment.
Its compatibility may depend on the versions of WordPress, WooCommerce, PHP, your theme, and other installed plugins.
Before updating WordPress or WooCommerce
For a significant platform update:
- Review the platform’s release information.
- Check SmartDescribe Pro’s documented compatibility requirements.
- Review compatibility information for other essential plugins.
- Create a backup.
- Test in staging where practical.
- Update the live website after completing the appropriate checks.
Do not assume that compatibility with one release guarantees compatibility with every future release.
PHP version changes
WordPress plugins execute within your hosting environment, which includes PHP.
Before changing your PHP version, confirm that WordPress, WooCommerce, SmartDescribe Pro, and your other essential plugins support the intended version.
If a problem begins immediately after a PHP change, investigate that change as a possible cause.
Do not change production PHP settings without understanding the implications and maintaining a suitable recovery option.
Theme and plugin interactions
Other components may affect administration pages, product editing, background processing, caching, or server resources.
If a problem appears after several components have been updated, investigate systematically rather than assuming SmartDescribe Pro is responsible.
9. Troubleshooting Update Problems
Problem: SmartDescribe Pro becomes inactive
Possible causes:
- The update did not complete correctly.
- A PHP error occurred.
- A compatibility issue was introduced.
- Required plugin files are missing.
Recommended actions:
- Check WordPress for an error message.
- Review relevant WordPress or hosting error logs.
- Confirm that the plugin files are present.
- Check compatibility with your installed WordPress, WooCommerce, and PHP versions.
- Follow the documented recovery procedure or restore a known-good backup if necessary.
- Contact support if the problem persists.
Avoid repeatedly activating and deactivating the plugin without investigating the underlying error.
Problem: Plugin settings appear to be missing
Possible causes:
- A setting was moved or renamed.
- The configuration interface changed.
- The update did not complete successfully.
- A database or permissions problem occurred.
Recommended actions:
- Review the release notes.
- Check all relevant plugin settings pages.
- Confirm that your WordPress account has appropriate permissions.
- Review available error logs.
- Investigate the current configuration before restoring older settings.
Do not assume the settings have been permanently lost until the issue has been investigated.
Problem: AI requests fail after updating
Possible causes:
- The AI provider changed its API requirements.
- The API key is invalid or lacks the necessary permissions.
- A configuration setting changed.
- The provider is experiencing an outage.
- A compatibility issue was introduced.
Recommended actions:
- Confirm the selected AI provider.
- Check the API key and provider account status.
- Review usage limits and available quota.
- Use the plugin’s connection test, if available.
- Review error messages and release information.
- Contact support if the issue remains unresolved.
Never include your complete API key in a support request.
Problem: Bulk optimisation fails after updating
Possible causes:
- A processing error.
- Server timeouts.
- API rate limits.
- Interrupted background tasks.
- Interactions with another plugin.
Recommended actions:
- Stop launching additional large jobs.
- Check whether an earlier job is still active.
- Test individual optimisation.
- Review available history or logs.
- Retry with a smaller batch if supported.
- Investigate server and provider errors.
Do not repeatedly restart a failed job without checking which products may already have been processed.
Problem: The public website displays unexpected information
Possible causes:
- Cached page content.
- A theme or plugin interaction.
- Product information that was not saved as expected.
- A compatibility problem.
Recommended actions:
- Check the saved product information in WordPress.
- Inspect the affected product page.
- Clear relevant caches if stored information is correct but the public page remains outdated.
- Test another product.
- Review recent changes to the theme, plugins, and hosting environment.
10. Rolling Back an Update
A rollback means returning to an earlier plugin version.
It may be appropriate when a confirmed problem prevents the plugin from working correctly and no immediate fix is available.
Before rolling back
First, determine whether the problem can be resolved through configuration, a compatibility adjustment, or a corrected release.
Review the release information to understand whether the update changed settings or stored data.
Important precautions
- Back up the current website state.
- Obtain the previous plugin package from a trusted source.
- Follow the documented rollback procedure.
- Check compatibility with your current WordPress and WooCommerce versions.
- Test the restored version.
- Verify existing settings and product information.
Rolling back plugin files does not necessarily reverse database changes.
If an update changed stored data, restoring an earlier database may be necessary. Database restoration can affect orders, products, customers, and other recent website changes.
If you are unsure how to restore the correct state, consult your hosting provider or developer before restoring a full database.
Security considerations
Avoid remaining on an outdated version indefinitely if the newer release addresses a security issue.
If a rollback is necessary, investigate the cause and move to a corrected release when an appropriate solution becomes available.
11. Establishing a Maintenance Routine
A simple maintenance routine helps reduce unexpected problems.
Regular checks
Periodically:
- Review available WordPress and plugin updates.
- Read relevant release notes.
- Confirm that backups are running.
- Check that SmartDescribe Pro remains active.
- Verify AI provider connectivity when necessary.
- Review failed optimisation tasks.
- Check scheduled jobs, where supported.
- Review a sample of your product image alt text.
Before significant changes
For major updates to WordPress, WooCommerce, PHP, or SmartDescribe Pro:
- Review compatibility.
- Create a backup.
- Test in staging where practical.
- Apply the update.
- Check the administration area.
- Run a small optimisation test.
- Verify the public website.
Keep a maintenance record
For a business website, record significant changes.
| Information | Example |
|---|---|
| Update date | Date the update was installed |
| Component | SmartDescribe Pro |
| Previous version | Version installed before the update |
| New version | Version installed after the update |
| Changes tested | Individual optimisation, bulk processing, etc. |
| Problems found | Any errors or unexpected behaviour |
| Outcome | Successful, rolled back, or awaiting investigation |
Never include passwords, API keys, or other confidential credentials in your maintenance records.
12. Update and Maintenance Checklist
Before updating
- Confirm the installed SmartDescribe Pro version.
- Review the release notes.
- Check compatibility requirements.
- Confirm that a recent backup is available.
- Record important settings securely.
- Choose an appropriate maintenance window.
- Use a staging site where practical.
After updating
- Confirm that SmartDescribe Pro is active.
- Check the administration pages.
- Verify the expected settings.
- Test AI provider connectivity.
- Test individual optimisation.
- Test bulk processing if you use it.
- Check scheduled optimisation if you use it.
- Verify that alt text is saved correctly.
- Check important product pages.
- Review error logs if unexpected behaviour occurs.
- Record the update and its outcome.
13. Frequently Asked Questions
Should I install every update immediately?
Security updates should be prioritised. For other updates, review the release information and apply appropriate precautions.
Maintain backups and follow any installation instructions supplied with the release.
Will updating SmartDescribe Pro remove my settings?
Do not assume that settings will be removed, but do not assume every update preserves every setting without change.
Review the release notes and verify your configuration after updating.
Do I need to deactivate the plugin before updating?
Follow the instructions supplied with your specific release and distribution method.
Do not deactivate or delete the existing plugin unless the documented procedure requires it.
Should I optimise my entire catalogue again after updating?
Not automatically.
Test the relevant functionality first. Reprocessing images that already have satisfactory alt text may create unnecessary work and additional API usage.
What should I do if an update breaks my store?
Investigate the error, consult the release information, and use an appropriate recovery procedure if necessary.
If the problem affects the wider store, involve your hosting provider or developer. Avoid making multiple unrelated changes at once, as this can make the cause harder to identify.
What information should I provide when requesting support?
Include:
- SmartDescribe Pro version.
- WordPress version.
- WooCommerce version.
- PHP version, if relevant.
- A clear description of the problem.
- The steps that reproduce the issue.
- Any relevant error messages with sensitive information removed.
Never send your complete API key, password, or other confidential credentials.
14. Final Recommendations
Maintaining SmartDescribe Pro is part of maintaining a healthy WooCommerce store.
For reliable operation:
- Keep the plugin and its supporting platform components maintained.
- Review release notes before significant updates.
- Maintain secure backups.
- Test important changes before applying them to a live store where possible.
- Verify that settings and optimisation workflows remain functional.
- Avoid unnecessary catalogue-wide reprocessing.
- Investigate errors systematically.
- Keep records of significant maintenance work.
A well-managed update process protects your store, reduces avoidable disruption, and helps you continue improving product image accessibility over time.
SmartDescribe Pro is a Cazgrae product. Available features, update methods, compatibility requirements, and menu labels may vary by installed version. Follow the release-specific installation and maintenance instructions supplied with your version.