添加产品规格文档并优化项目结构
Made-with: Cursor
This commit is contained in:
@@ -1,168 +1,107 @@
|
||||
# JSON-LD Schema.org 结构化数据生成功能说明
|
||||
|
||||
## 📋 功能概述
|
||||
## 功能概述
|
||||
|
||||
JSON-LD Schema.org 结构化数据生成模块是 GEO 工具的核心功能之一,用于生成符合 Schema.org 规范的 JSON-LD 代码,直接提升品牌在 AI 模型中的实体识别和权威性。
|
||||
JSON-LD Schema.org 结构化数据生成模块帮助用户生成符合 Schema.org 规范的 JSON-LD 代码,提升品牌在 AI 模型中的实体识别和权威性。
|
||||
|
||||
### 核心价值
|
||||
## 为什么需要 Schema.org?
|
||||
|
||||
- **直接提升实体识别**:2026 年 AI 模型越来越依赖结构化数据识别实体
|
||||
- **立竿见影的效果**:用户可直接将代码贴到官网/GitHub,无需等待索引
|
||||
- **权威性提升**:结构化数据明确标识品牌信息,提升在知识图谱中的权威性
|
||||
- **符合标准**:使用 Schema.org 标准,被 Google、百度、AI 模型广泛支持
|
||||
1. **帮助 AI 理解**:结构化数据让 AI 更容易理解您的品牌和产品
|
||||
2. **提升权威性**:Schema.org 是国际标准,使用它能增加内容的可信度
|
||||
3. **富媒体展示**:搜索引擎可以使用 Schema 数据生成富媒体搜索结果
|
||||
|
||||
## 🎯 功能位置
|
||||
## 支持的 Schema 类型
|
||||
|
||||
### 1. Tab2(自动创作)- 独立生成模块
|
||||
| 类型 | 说明 | 适用场景 |
|
||||
|------|------|----------|
|
||||
| Organization | 组织/公司 | 企业品牌介绍 |
|
||||
| SoftwareApplication | 软件应用 | SaaS 产品、软件工具 |
|
||||
| Product | 产品 | 实体产品或数字产品 |
|
||||
| Service | 服务 | 服务类业务 |
|
||||
| FAQPage | FAQ 页面 | 常见问题解答 |
|
||||
| HowTo | 操作指南 | 教程、步骤说明 |
|
||||
| Article | 文章 | 博客、新闻文章 |
|
||||
| Review | 评价 | 产品/服务评价 |
|
||||
|
||||
在 Tab2 顶部,提供独立的 JSON-LD Schema 生成功能:
|
||||
## 使用方式
|
||||
|
||||
1. **选择 Schema 类型**
|
||||
- Organization(组织/公司)
|
||||
- SoftwareApplication(软件应用)
|
||||
- Product(产品)
|
||||
- Service(服务)
|
||||
- 组合(Organization + SoftwareApplication)
|
||||
### 1. 生成 Schema
|
||||
|
||||
2. **一键生成**
|
||||
- 点击"🚀 生成 JSON-LD"按钮
|
||||
- 自动基于品牌信息和优势生成 Schema
|
||||
在内容优化或自动创作完成后,系统会提示是否生成 Schema。
|
||||
|
||||
3. **查看和下载**
|
||||
- 查看 JSON-LD 代码
|
||||
- 查看 HTML Script 标签
|
||||
- 下载 JSON 文件或 HTML 文件
|
||||
### 2. 选择 Schema 类型
|
||||
|
||||
### 2. Tab2(自动创作)- 自动生成
|
||||
根据内容类型选择合适的 Schema 类型。
|
||||
|
||||
在生成 GitHub README 时,系统会自动生成对应的 JSON-LD Schema:
|
||||
### 3. 嵌入到网页
|
||||
|
||||
- 自动生成 SoftwareApplication 类型的 Schema
|
||||
- 在内容预览区域显示 JSON-LD 代码
|
||||
- 提供下载功能
|
||||
将生成的 JSON-LD 代码嵌入到网页的 `<head>` 标签中。
|
||||
|
||||
## 📊 支持的 Schema 类型
|
||||
## 代码示例
|
||||
|
||||
### 1. Organization(组织/公司)
|
||||
### 基本用法
|
||||
|
||||
适合:企业品牌、公司官网
|
||||
```python
|
||||
from modules.schema_generator import SchemaGenerator
|
||||
|
||||
**包含字段:**
|
||||
- name(名称)
|
||||
- description(描述)
|
||||
- url(官网 URL)
|
||||
- logo(Logo URL)
|
||||
- foundingDate(成立日期)
|
||||
- contactPoint(联系方式)
|
||||
generator = SchemaGenerator()
|
||||
|
||||
**使用场景:**
|
||||
- 公司官网
|
||||
- 企业介绍页面
|
||||
- 关于我们页面
|
||||
# 生成 Organization Schema
|
||||
schema = generator.generate_organization_schema(
|
||||
brand_name="YourBrand",
|
||||
description="YourBrand description",
|
||||
url="https://example.com"
|
||||
)
|
||||
|
||||
### 2. SoftwareApplication(软件应用)
|
||||
# 生成 HTML 标签
|
||||
html_tag = generator.generate_html_script_tag(schema)
|
||||
print(html_tag)
|
||||
```
|
||||
|
||||
适合:SaaS 产品、软件工具、应用程序
|
||||
### 生成 FAQ Schema
|
||||
|
||||
**包含字段:**
|
||||
- name(应用名称)
|
||||
- description(应用描述)
|
||||
- url(应用 URL)
|
||||
- applicationCategory(应用类别)
|
||||
- operatingSystem(操作系统)
|
||||
- publisher(发布者)
|
||||
- featureList(功能列表)
|
||||
- offers(价格信息)
|
||||
- aggregateRating(评分信息)
|
||||
```python
|
||||
# 从内容中自动提取 Q&A
|
||||
faq_schema = generator.auto_generate_faq_schema(content)
|
||||
|
||||
**使用场景:**
|
||||
- GitHub 项目
|
||||
- 软件官网
|
||||
- 应用商店页面
|
||||
# 手动创建 FAQ
|
||||
faq_items = [
|
||||
{"question": "产品有什么优势?", "answer": "我们的产品具有..."},
|
||||
{"question": "如何开始使用?", "answer": "只需三步..."}
|
||||
]
|
||||
faq_schema = generator.generate_faq_schema(faq_items)
|
||||
```
|
||||
|
||||
### 3. Product(产品)
|
||||
### 生成 HowTo Schema
|
||||
|
||||
适合:实体产品或数字产品
|
||||
```python
|
||||
steps = [
|
||||
{"name": "注册账号", "text": "访问官网注册账号"},
|
||||
{"name": "配置设置", "text": "完成基础配置"},
|
||||
{"name": "开始使用", "text": "开始使用核心功能"}
|
||||
]
|
||||
howto_schema = generator.generate_howto_schema(
|
||||
title="如何开始使用",
|
||||
steps=steps,
|
||||
description="快速入门指南"
|
||||
)
|
||||
```
|
||||
|
||||
**包含字段:**
|
||||
- name(产品名称)
|
||||
- description(产品描述)
|
||||
- url(产品 URL)
|
||||
- category(产品类别)
|
||||
- brand(品牌信息)
|
||||
- offers(价格信息)
|
||||
- aggregateRating(评分信息)
|
||||
## 嵌入示例
|
||||
|
||||
**使用场景:**
|
||||
- 产品详情页
|
||||
- 电商页面
|
||||
- 产品介绍页
|
||||
|
||||
### 4. Service(服务)
|
||||
|
||||
适合:服务类业务
|
||||
|
||||
**包含字段:**
|
||||
- name(服务名称)
|
||||
- description(服务描述)
|
||||
- url(服务 URL)
|
||||
- serviceType(服务类型)
|
||||
- provider(服务提供者)
|
||||
- areaServed(服务区域)
|
||||
- offers(价格信息)
|
||||
|
||||
**使用场景:**
|
||||
- 服务介绍页
|
||||
- 服务详情页
|
||||
- 业务介绍页
|
||||
|
||||
### 5. 组合 Schema
|
||||
|
||||
同时生成 Organization + SoftwareApplication/Product/Service
|
||||
|
||||
**优势:**
|
||||
- 同时标识组织信息和产品/服务信息
|
||||
- 建立更完整的品牌知识图谱
|
||||
- 提升权威性
|
||||
|
||||
## 🔄 使用方法
|
||||
|
||||
### 方法一:独立生成(推荐)
|
||||
|
||||
1. **进入 Tab2(自动创作)**
|
||||
2. **选择 Schema 类型**
|
||||
- 根据您的业务类型选择(软件产品选 SoftwareApplication,公司选 Organization)
|
||||
3. **点击"🚀 生成 JSON-LD"**
|
||||
4. **查看生成的代码**
|
||||
- JSON-LD 代码:可直接使用
|
||||
- HTML Script 标签:可直接嵌入网页
|
||||
5. **下载代码**
|
||||
- 下载 JSON 文件:用于 GitHub 等平台
|
||||
- 下载 HTML 文件:用于官网嵌入
|
||||
|
||||
### 方法二:自动生成(GitHub README)
|
||||
|
||||
1. **在 Tab2 生成 GitHub README 内容**
|
||||
2. **系统自动生成对应的 JSON-LD Schema**
|
||||
3. **在内容预览区域查看 JSON-LD 代码**
|
||||
4. **下载并添加到 GitHub 项目**
|
||||
|
||||
## 📝 使用示例
|
||||
|
||||
### 示例 1:嵌入官网
|
||||
### 示例 1:添加到网页 HTML
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>我的品牌</title>
|
||||
<!-- 将生成的 HTML Script 标签粘贴到这里 -->
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "SoftwareApplication",
|
||||
"name": "汇信云AI软件",
|
||||
"description": "AI赋能外贸ERP...",
|
||||
"name": "YourBrand",
|
||||
"description": "Product description",
|
||||
...
|
||||
}
|
||||
</script>
|
||||
@@ -187,81 +126,37 @@ JSON-LD Schema.org 结构化数据生成模块是 GEO 工具的核心功能之
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "SoftwareApplication",
|
||||
...
|
||||
"name": "YourBrand"
|
||||
}
|
||||
</script>
|
||||
```
|
||||
|
||||
## 🎯 最佳实践
|
||||
## 最佳实践
|
||||
|
||||
1. **选择合适的 Schema 类型**
|
||||
- SaaS 产品:SoftwareApplication
|
||||
- 企业品牌:Organization
|
||||
- 实体产品:Product
|
||||
- 服务业务:Service
|
||||
1. **选择正确的类型**:根据内容选择最合适的 Schema 类型
|
||||
2. **提供完整信息**:尽可能填写所有相关字段
|
||||
3. **保持更新**:内容更新时同步更新 Schema
|
||||
4. **验证有效性**:使用 Google Rich Results Test 验证
|
||||
|
||||
2. **完善 Schema 信息**
|
||||
- 添加官网 URL
|
||||
- 添加 Logo URL
|
||||
- 添加联系方式
|
||||
- 添加功能列表(如适用)
|
||||
## 验证工具
|
||||
|
||||
3. **验证 Schema**
|
||||
- 使用 [Google Rich Results Test](https://search.google.com/test/rich-results) 验证
|
||||
- 使用 [Schema.org Validator](https://validator.schema.org/) 验证
|
||||
|
||||
4. **多平台部署**
|
||||
- 官网:嵌入 HTML Script 标签
|
||||
- GitHub:添加到 README.md
|
||||
- 其他平台:根据平台要求调整
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
1. **不要编造信息**
|
||||
- 所有信息必须真实
|
||||
- URL 必须可访问
|
||||
- Logo 必须存在
|
||||
|
||||
2. **保持更新**
|
||||
- 品牌信息变化时及时更新 Schema
|
||||
- 定期检查 Schema 有效性
|
||||
|
||||
3. **遵循规范**
|
||||
- 使用标准的 Schema.org 类型
|
||||
- 确保 JSON 格式正确
|
||||
- 避免使用不支持的属性
|
||||
|
||||
4. **测试验证**
|
||||
- 部署前使用验证工具测试
|
||||
- 确保 AI 模型能正确解析
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
- [Schema.org 官方文档](https://schema.org/)
|
||||
- [Google Rich Results Test](https://search.google.com/test/rich-results)
|
||||
- [Schema.org Validator](https://validator.schema.org/)
|
||||
- [JSON-LD 规范](https://json-ld.org/)
|
||||
|
||||
## 💡 预期效果
|
||||
## 技术实现
|
||||
|
||||
使用 JSON-LD Schema.org 结构化数据后:
|
||||
### 核心模块
|
||||
|
||||
1. **AI 模型识别**
|
||||
- AI 模型能更准确地识别品牌实体
|
||||
- 提升品牌在知识图谱中的权威性
|
||||
- 改善品牌信息的准确性
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| `modules/schema_generator.py` | Schema 生成器 |
|
||||
|
||||
2. **搜索引擎优化**
|
||||
- 提升在 Google、百度等搜索引擎中的展示
|
||||
- 可能获得 Rich Results(富媒体结果)
|
||||
- 提升点击率
|
||||
### API 接口
|
||||
|
||||
3. **知识图谱**
|
||||
- 建立品牌在知识图谱中的节点
|
||||
- 与其他实体建立关联
|
||||
- 提升品牌权威性
|
||||
|
||||
---
|
||||
|
||||
**版本**:v1.0
|
||||
**更新日期**:2025-01-26
|
||||
- `generate_organization_schema()` - 生成组织 Schema
|
||||
- `generate_software_application_schema()` - 生成软件应用 Schema
|
||||
- `generate_faq_schema()` - 生成 FAQ Schema
|
||||
- `generate_howto_schema()` - 生成 HowTo Schema
|
||||
- `generate_article_schema()` - 生成文章 Schema
|
||||
- `generate_review_schema()` - 生成评价 Schema
|
||||
- `auto_generate_faq_schema()` - 从内容自动提取 Q&A 并生成 Schema
|
||||
|
||||
Reference in New Issue
Block a user