docs/woo-marketplace/content-style-guide.md
This guide provides formatting and writing standards for creating product pages and documentation on the WooCommerce Marketplace. Following these guidelines ensures consistency across the Marketplace and creates a professional experience for merchants browsing and purchasing extensions.
For product page structure, required elements, and asset specifications, refer to Product Page Content and Assets.
Use the format "Product Name for WooCommerce" rather than "WooCommerce Product Name" throughout the product copy.
This format ensures your product name complies with trademark rules and leads with its unique identifier, improving discoverability and clarity.
Follow the WooCommerce grammar, punctuation, and capitalization guide for comprehensive guidance. Key points include:
Use the Oxford comma when listing three or more items:
Use active voice instead of passive voice whenever possible:
Capitalization:
Spelling and terminology:
Maintain clean, consistent formatting by following these standards. Custom styling interferes with the Marketplace design system and creates an inconsistent experience.
Do not:
Do:
Do not:
Do:
Do not:
Do:
Do not:
Do:
Do not use emojis in product pages or documentation. Emojis can cause accessibility issues, display inconsistently across devices, and create an unprofessional appearance.
Do not include links to external websites. All support and documentation links should point to Marketplace URLs:
The WooCommerce Marketplace provides several formatting tools to create visually appealing content while maintaining consistency.
Use these CSS classes to create professional checkmark lists:
Creates bold checkmarks in green circles. Use for main benefit lists at the top of your product description.
<ul class="wccom-tick-list-primary">
<li>Accept payments globally</li>
<li>Automatic tax calculation</li>
<li>Real-time shipping rates</li>
</ul>
Creates lightweight green checkmarks. Use for feature lists and secondary content throughout the page.
<ul class="wccom-tick-list-secondary">
<li>Supports 100+ currencies</li>
<li>PCI compliant</li>
<li>Automatic updates</li>
</ul>
Use the box shortcode to highlight important information. Available styles:
For general tips and helpful information:
[box]This extension requires WooCommerce 8.0 or higher.[/box]
This component can be used with or without style="info".
For warnings or important notices:
[box style="alert"]Backup your site before updating to the latest version.[/box]
For critical warnings or known limitations:
[box style="error"]This extension is not compatible with multisite installations.[/box]
For positive confirmations or best practices:
[box style="success"]Your API credentials are securely encrypted and stored.[/box]
:::info Use callout boxes sparingly. Overuse reduces their impact and creates visual clutter. :::
When creating documentation for your product, follow these additional guidelines:
For detailed documentation frameworks, refer to Support and Documentation Best Practices.
When adding visual content: