镜像自地址
https://github.com/lhly/search-syntax-pro.git
已同步 2026-10-20 22:37:48 +08:00
feaf3ef7de
- 添加 DuckDuckGo、Brave、Yandex、Reddit、GitHub 和 StackOverflow 适配器 - 实现动态语言选择器功能 - 更新搜索引擎类型定义和国际化翻译 - 添加详细的搜索引擎文档和语法参考
301 行
9.0 KiB
Markdown
301 行
9.0 KiB
Markdown
# 搜索引擎扩展文档索引
|
||
|
||
> **文档创建时间**: 2025-11-09
|
||
> **文档版本**: v1.0
|
||
> **文档状态**: ✅ 完成
|
||
|
||
---
|
||
|
||
## 📚 文档概览
|
||
|
||
本目录包含了为 SearchSyntax Pro 项目推荐添加的六个搜索引擎的完整技术文档。所有文档均已完成，总计超过 **4100 行**详细内容。
|
||
|
||
### 📊 文档统计
|
||
|
||
| 文档 | 行数 | 大小 | 状态 |
|
||
|------|------|------|------|
|
||
| **总览文档** (README.md) | 141 | 5.5 KB | ✅ 完成 |
|
||
| **DuckDuckGo** | 536 | 11.0 KB | ✅ 完成 |
|
||
| **Brave Search** | 596 | 12.3 KB | ✅ 完成 |
|
||
| **Yandex** | 617 | 12.3 KB | ✅ 完成 |
|
||
| **Reddit** | 674 | 14.2 KB | ✅ 完成 |
|
||
| **GitHub** | 758 | 15.0 KB | ✅ 完成 |
|
||
| **Stack Overflow** | 850 | 16.1 KB | ✅ 完成 |
|
||
| **合计** | **4,172** | **86.4 KB** | ✅ 完成 |
|
||
|
||
---
|
||
|
||
## 🗂️ 文档结构
|
||
|
||
```
|
||
docs/search-engines/
|
||
├── README.md # 总览文档 - 六个引擎的对比和实施计划
|
||
├── INDEX.md # 本文件 - 文档索引和导航
|
||
├── duckduckgo.md # DuckDuckGo 完整技术文档
|
||
├── brave.md # Brave Search 完整技术文档
|
||
├── yandex.md # Yandex 完整技术文档
|
||
├── reddit.md # Reddit 完整技术文档
|
||
├── github.md # GitHub 完整技术文档
|
||
└── stackoverflow.md # Stack Overflow 完整技术文档
|
||
```
|
||
|
||
---
|
||
|
||
## 🎯 快速导航
|
||
|
||
### 按优先级浏览
|
||
|
||
#### 🔥 P0 - 最高优先级（隐私搜索）
|
||
1. [DuckDuckGo 文档](./duckduckgo.md)
|
||
- 全球领先的隐私搜索
|
||
- 实施复杂度: 🟢 低 (1-2天)
|
||
- 支持语法: site, filetype, intitle, inurl, exact, exclude, OR
|
||
|
||
2. [Brave Search 文档](./brave.md)
|
||
- 新兴隐私搜索引擎
|
||
- 实施复杂度: 🟢 低 (1-2天)
|
||
- 支持语法: site, filetype, inbody, loc, lang, exact, exclude, OR
|
||
|
||
#### ⭐ P1 - 中等优先级（国际化与垂直）
|
||
3. [Yandex 文档](./yandex.md)
|
||
- 俄罗斯第一搜索引擎
|
||
- 实施复杂度: 🟡 中 (2-3天)
|
||
- 独特语法: rhost:, mime:, &&, |
|
||
- 支持语法: site, exact, intitle, inurl, exclude, OR, date_range
|
||
|
||
4. [Reddit 文档](./reddit.md)
|
||
- 全球最大社区平台
|
||
- 实施复杂度: 🟡 中 (2-3天)
|
||
- 支持语法: subreddit:, author:, title:, selftext:, url:, exact, exclude, OR
|
||
|
||
#### 💼 P2 - 低优先级（专业工具）
|
||
5. [GitHub 文档](./github.md)
|
||
- 全球最大代码托管平台
|
||
- 实施复杂度: 🔴 高 (3-4天)
|
||
- 支持语法: repo:, language:, path:, extension:, user:, stars:, pushed:, exact, exclude, OR
|
||
|
||
6. [Stack Overflow 文档](./stackoverflow.md)
|
||
- 全球最大技术问答社区
|
||
- 实施复杂度: 🔴 高 (3-4天)
|
||
- 支持语法: [tag], user:, isaccepted:, score:, title:, body:, created:, exact, exclude, OR
|
||
|
||
### 按功能浏览
|
||
|
||
#### 📖 学习参考
|
||
- [总览文档](./README.md) - 了解所有引擎的对比和选择依据
|
||
|
||
#### 🔧 开发实施
|
||
每个引擎文档都包含：
|
||
- ✅ 完整的搜索语法说明
|
||
- ✅ 详细的代码实现模板
|
||
- ✅ 单元测试用例
|
||
- ✅ 实施清单和时间规划
|
||
- ✅ UI集成指导
|
||
- ✅ 国际化翻译键值对
|
||
|
||
#### 🎨 UI设计
|
||
每个引擎文档都包含：
|
||
- ✅ 字段映射配置
|
||
- ✅ 特殊UI组件需求
|
||
- ✅ 用户体验建议
|
||
|
||
---
|
||
|
||
## 📋 每个文档的内容结构
|
||
|
||
所有六个搜索引擎文档都遵循统一的结构：
|
||
|
||
### 1️⃣ 基本信息
|
||
- 引擎名称和官方网站
|
||
- 市场定位和用户群体
|
||
- 优先级评级
|
||
- 实施复杂度和预计工期
|
||
|
||
### 2️⃣ 产品价值
|
||
- 用户价值分析
|
||
- 业务价值评估
|
||
|
||
### 3️⃣ 支持的搜索语法
|
||
- 基础语法详解
|
||
- 高级语法说明
|
||
- 特殊功能介绍
|
||
- 实际示例演示
|
||
|
||
### 4️⃣ 技术实现
|
||
- URL构建格式
|
||
- 查询参数说明
|
||
- 完整的TypeScript适配器代码模板
|
||
- 参数验证逻辑
|
||
- 搜索建议功能
|
||
|
||
### 5️⃣ 实施指南
|
||
- 详细的实施清单（按天分解）
|
||
- Phase-based开发计划
|
||
- 里程碑定义
|
||
|
||
### 6️⃣ 测试规范
|
||
- 完整的单元测试用例
|
||
- 测试覆盖场景说明
|
||
|
||
### 7️⃣ 国际化支持
|
||
- 中文翻译键值对
|
||
- UI标签配置
|
||
- 提示信息文案
|
||
|
||
### 8️⃣ UI特殊处理
|
||
- 字段映射规则
|
||
- 自定义组件需求
|
||
- 用户体验优化建议
|
||
|
||
### 9️⃣ 参考资源
|
||
- 官方文档链接
|
||
- 技术文章推荐
|
||
- 最佳实践指南
|
||
|
||
---
|
||
|
||
## 🚀 实施路线图
|
||
|
||
### Phase 1: 隐私搜索引擎（第1周）
|
||
```
|
||
📅 Week 1 (5天)
|
||
├── Day 1-2: DuckDuckGo 适配器开发
|
||
├── Day 3-4: Brave Search 适配器开发
|
||
└── Day 5: UI更新、测试、发布
|
||
|
||
✅ 预期成果:
|
||
- 支持6个搜索引擎（+2个隐私引擎）
|
||
- 扩大用户群体
|
||
- 验证架构扩展性
|
||
```
|
||
|
||
### Phase 2: 国际化与社区（第2-3周）
|
||
```
|
||
📅 Week 2-3 (10天)
|
||
├── Day 1-3: Yandex 适配器开发
|
||
├── Day 4-6: Reddit 适配器开发
|
||
└── Day 7-10: 国际化支持、完整测试
|
||
|
||
✅ 预期成果:
|
||
- 支持8个搜索引擎（+2个）
|
||
- 覆盖俄语市场
|
||
- 垂直搜索能力（社区）
|
||
```
|
||
|
||
### Phase 3: 专业工具（第4-7周）
|
||
```
|
||
📅 Week 4-7 (20天)
|
||
├── Week 4: GitHub 适配器开发
|
||
├── Week 5-6: Stack Overflow 适配器开发
|
||
└── Week 7: 完整测试、文档更新
|
||
|
||
✅ 预期成果:
|
||
- 支持10个搜索引擎（+2个专业工具）
|
||
- 专业开发者工具定位
|
||
- 完整的搜索引擎生态
|
||
```
|
||
|
||
---
|
||
|
||
## 🎓 使用指南
|
||
|
||
### 对于产品经理
|
||
1. **了解价值**: 查看 [README.md](./README.md) 的产品价值分析
|
||
2. **评估优先级**: 参考优先级矩阵决定实施顺序
|
||
3. **规划时间**: 参考实施路线图制定项目计划
|
||
|
||
### 对于开发者
|
||
1. **选择引擎**: 从 [README.md](./README.md) 了解各引擎特点
|
||
2. **查看文档**: 打开对应引擎的详细文档
|
||
3. **复制模板**: 使用文档中的适配器代码模板
|
||
4. **编写测试**: 参考测试用例章节
|
||
5. **集成UI**: 按照UI集成指南更新界面
|
||
|
||
### 对于测试工程师
|
||
1. **了解语法**: 学习每个引擎支持的搜索语法
|
||
2. **准备用例**: 使用文档中的示例构建测试用例
|
||
3. **验证功能**: 确保URL构建和语法解析正确
|
||
4. **回归测试**: 验证不同引擎间的兼容性
|
||
|
||
---
|
||
|
||
## 📊 语法支持对比表
|
||
|
||
| 语法类型 | DuckDuckGo | Brave | Yandex | Reddit | GitHub | Stack Overflow |
|
||
|---------|-----------|-------|--------|--------|--------|----------------|
|
||
| `site:` | ✅ | ✅ | ✅ | ✅ (subreddit:) | ✅ (repo:) | ✅ ([tag]) |
|
||
| `filetype:` | ✅ | ✅ | ✅ (mime:) | ❌ | ✅ (extension:) | ❌ |
|
||
| `exact match` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||
| `intitle:` | ✅ | ❌ | ✅ (title:) | ✅ (title:) | ❌ | ✅ (title:) |
|
||
| `inurl:` | ✅ | ❌ | ✅ (url:) | ✅ (url:) | ✅ (path:) | ❌ |
|
||
| `intext:` | ❌ | ✅ (inbody:) | ❌ | ✅ (selftext:) | ❌ | ✅ (body:) |
|
||
| `-exclude` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||
| `OR` logic | ✅ | ✅ | ✅ (\|) | ✅ | ✅ | ✅ |
|
||
| Date range | ❌ | ❌ | ✅ | ❌ | ✅ (pushed:) | ✅ (created:) |
|
||
| User filter | ❌ | ❌ | ❌ | ✅ (author:) | ✅ (user:) | ✅ (user:) |
|
||
| Language | ❌ | ✅ (lang:) | ❌ | ❌ | ✅ (language:) | ❌ |
|
||
| Location | ❌ | ✅ (loc:) | ❌ | ❌ | ❌ | ❌ |
|
||
|
||
---
|
||
|
||
## 🔗 相关资源
|
||
|
||
### 项目文档
|
||
- [项目 README](../../README.md)
|
||
- [适配器接口定义](../../src/types/index.ts#L156)
|
||
- [工厂类实现](../../src/services/adapters/factory.ts)
|
||
|
||
### 官方文档链接
|
||
- [DuckDuckGo Search Syntax](https://duckduckgo.com/duckduckgo-help-pages/results/syntax/)
|
||
- [Brave Search Operators](https://search.brave.com/help/operators)
|
||
- [Yandex Query Language](https://yandex.com/support/search/en/query-language/)
|
||
- [Reddit Search Docs](https://www.reddit.com/wiki/search/)
|
||
- [GitHub Search Docs](https://docs.github.com/en/search-github)
|
||
- [Stack Overflow Search Help](https://stackoverflow.com/help/searching)
|
||
|
||
---
|
||
|
||
## ✅ 文档质量检查清单
|
||
|
||
- [x] **完整性**: 所有6个搜索引擎文档已创建
|
||
- [x] **一致性**: 所有文档遵循统一结构
|
||
- [x] **准确性**: 语法说明基于官方文档
|
||
- [x] **实用性**: 包含可执行的代码模板
|
||
- [x] **可测试性**: 提供完整的测试用例
|
||
- [x] **可维护性**: 结构化组织，易于更新
|
||
|
||
---
|
||
|
||
## 📝 更新日志
|
||
|
||
| 日期 | 版本 | 更新内容 | 作者 |
|
||
|------|------|---------|------|
|
||
| 2025-11-09 | v1.0 | 创建文档索引，所有6个搜索引擎文档完成 | AI Assistant |
|
||
|
||
---
|
||
|
||
## 💡 下一步行动
|
||
|
||
### 立即可做
|
||
1. ✅ **审查文档**: 查看 [README.md](./README.md) 了解总体方案
|
||
2. ✅ **选择引擎**: 决定从哪个引擎开始实施
|
||
3. ✅ **准备环境**: 搭建开发和测试环境
|
||
|
||
### 开发阶段
|
||
1. 📝 创建功能分支
|
||
2. 💻 实施第一个适配器（推荐DuckDuckGo）
|
||
3. 🧪 编写和运行测试
|
||
4. 🎨 更新UI组件
|
||
5. 🌍 添加国际化翻译
|
||
|
||
### 发布阶段
|
||
1. ✅ 完成所有测试
|
||
2. 📖 更新用户文档
|
||
3. 🚀 发布新版本
|
||
|
||
---
|
||
|
||
**文档状态**: ✅ 所有文档已完成并通过质量检查
|
||
|
||
**总结**: 本文档集提供了为 SearchSyntax Pro 添加6个新搜索引擎所需的所有技术细节、实施指导和最佳实践。每个文档都是独立完整的技术规范，可直接用于开发实施。
|