跳到主要内容

Marketplace 内容样式指南

本指南提供了在 WooCommerce Marketplace 上创建产品页面和文档的格式和写作标准。遵循这些指南可确保 Marketplace 上的统一性，并为浏览和购买扩展的商家提供专业的体验。

有关产品页面结构、必需元素和资源规范，请参阅 产品页面内容和资源。

写作标准​

产品命名规范​

在整个产品描述中使用 "Product Name for WooCommerce" 格式，而不是 "WooCommerce Product Name" 格式。

此格式可确保您的产品名称符合 商标规则，并以其唯一标识符开头，从而提高可发现性和清晰度。

语法和标点​

请遵循 WooCommerce 语法、标点和首字母大写指南，以获得全面的指导。 关键点包括：

使用牛津逗号，当列出三个或更多项时：

  • ✓ "跟踪订单、管理库存和处理退款。"
  • ✗ "跟踪订单、管理库存和处理退款。"

尽可能使用主动语态，而不是被动语态：

  • ✓ "该扩展在订单发货时发送邮件通知。"
  • ✗ "该扩展在订单发货时发送邮件通知。"

首字母大写：

  • 对于标题，使用句首大写（仅大写第一个单词和专有名词）
  • 不要使用全大写进行强调
  • 正确地大写产品名称、功能和 WooCommerce 术语

拼写和术语：

  • 使用美式英语拼写
  • 使用 "ecommerce"（小写，无连字符）
  • 使用 "WooCommerce"（不要使用 "Woocommerce" 或 "wooCommerce"）

格式指南​

通过遵循以下标准，保持清晰、一致的格式。 自定义样式会干扰 Marketplace 的设计系统，并创建不一致的体验。

文本格式​

不要：

  • 居中对齐标题或正文
  • 更改默认文字颜色
  • 添加自定义字体大小或字体
  • 过度使用粗体或斜体

可以：

  • 在整个文档中使用左对齐文本
  • 允许标题和段落继承默认样式
  • 仅对关键术语谨慎使用粗体

标题​

不要：

  • 每个网页包含超过一个 H1 标签（产品标题用作 H1）
  • 居中对齐标题
  • 对标题应用自定义颜色或样式

可以：

  • 使用 H2 作为主要部分
  • 使用 H3 作为 H2 部分中的子部分
  • 保持逻辑的标题层级结构（不要跳过级别）

章节和布局​

请勿：

  • 创建自定义样式的章节或容器
  • 在章节周围添加边框
  • 将背景颜色应用于内容区域
  • 添加章节之间的自定义间距
  • 添加额外的样式到列

请：

  • 使用标准的段落和标题块
  • 让 Marketplace 模板处理章节的间距
  • 使用默认的列块，不进行样式修改

列表​

请勿：

  • 使用自定义 CSS 自定义项目符号或编号的设计
  • 添加列表项之间的自定义间距
  • 创建嵌套列表的深度超过两级

请：

  • 使用标准的无序或有序列表块
  • 使用批准的列表类来创建带有样式的复选标记（请参见下面的“格式化工具”）

内容限制​

表情符号​

请勿在产品页面或文档中使用表情符号。表情符号可能导致可访问性问题，在不同设备上的显示不一致，并可能产生不专业的视觉效果。

  • ✗ "🚀 提升您的销量！"
  • ✓ "提升您的销量"

外部链接​

请勿包含指向外部网站的链接。所有支持和文档链接应指向 Marketplace 的 URL：

  • 将产品文档的链接指向托管在 WooCommerce.com 上的位置
  • 将链接指向 Marketplace 的支持资源
  • 请勿链接到外部支持门户、文档网站或着陆页

格式化工具​

WooCommerce Marketplace 提供了多种格式化工具，可用于创建具有视觉吸引力的内容，同时保持一致性。

样式化列表类​

使用以下 CSS 类来创建专业的复选标记列表：

主要复选标记列表 (wccom-tick-list-primary)​

创建带有粗体绿色圆圈的复选标记。用于产品描述顶部的主要优势列表。

<ul class="wccom-tick-list-primary">
  <li>支持全球支付</li>
  <li>自动计算税费</li>
  <li>实时运费计算</li>
</ul>

辅助复选标记列表 (wccom-tick-list-secondary)​

创建轻量级的绿色复选标记。用于整个页面的功能列表和辅助内容。

<ul class="wccom-tick-list-secondary">
  <li>支持 100 多个货币</li>
  <li>符合 PCI 标准</li>
  <li>自动更新</li>
</ul>

提示框​

使用提示框短代码来突出显示重要信息。可用的样式：

信息提示框​

用于提供一般提示和有用的信息：

[box]此扩展程序需要 WooCommerce 8.0 或更高版本。[/box]

此组件可以不带或带有 style="info" 属性使用。

警告提示框 (style="alert")​

用于警告或重要通知：

[box style="alert"]在更新到最新版本之前，请备份您的网站。[/box]

错误提示框 (style="error")​

用于关键警告或已知限制：

[box style="error"]此扩展程序与多站点安装不兼容。[/box]

成功提示框 (style="success")​

用于积极的确认或最佳实践：

[box style="success"]您的 API 凭据已安全加密并存储。</box>
信息

谨慎使用提示框。过度使用会降低其效果并造成视觉混乱。

文档标准​

在为您的产品创建文档时，请遵循以下附加指南：

结构​

  • 从清晰的介绍开始，解释该扩展程序的作用
  • 请使用名为 "Docs – Installation" 的同步模式。这解释了我们的客户如何从 WooCommerce.com 购买和安装产品。
  • 记录您产品的所有功能和设置
  • 提供常见问题的故障排除指南

有关详细的文档框架，请参阅 支持和文档最佳实践。

图片和截图​

在添加视觉内容时：

  • 使用现代的 WordPress 管理员配色方案
  • 使用最新的 WordPress 核心主题，除非您正在记录不同的主题
  • 确保截图清晰易读
  • 优化文件大小
  • 请勿在截图中包含敏感或个人信息
  • 为所有图片添加替代文本，以提高可访问性。