Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
273 changes: 273 additions & 0 deletions .github/prompts/OVERVIEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
# 🎯 ObjectStack AI Prompts - Complete Overview

## 生成的所有AI提示词 (All Generated AI Prompts)

本文档总结了为 ObjectStack 规范仓库生成的所有 AI 提示词。

---

## 📊 提示词架构 (Prompt Architecture)

```
ObjectStack AI Prompts
├── 🏗️ Protocol Architecture Layer (协议架构层)
│ ├── 📊 Data Protocol (数据协议)
│ │ └── 定义 ObjectQL:字段、对象、验证、权限、工作流
│ │
│ ├── 🎨 UI Protocol (UI协议)
│ │ └── 定义 ObjectUI:视图、应用、仪表板、报表
│ │
│ ├── ⚙️ System Protocol (系统协议)
│ │ └── 定义 ObjectOS:清单、插件、驱动、身份认证
│ │
│ ├── 🤖 AI Protocol (AI协议)
│ │ └── 定义 AI集成:代理、工具、知识库、对话
│ │
│ └── 🌐 API Protocol (API协议)
│ └── 定义 API契约:请求、响应、错误、端点
├── 👥 Development Roles Layer (开发角色层)
│ ├── 🧪 Testing Engineer (测试工程师)
│ │ └── 编写测试、提高覆盖率、验证模式
│ │
│ ├── 📚 Documentation Writer (文档编写者)
│ │ └── 编写文档、添加注释、创建教程
│ │
│ └── 💡 Example Creator (示例创建者)
│ └── 创建示例、演示应用、参考实现
└── 📖 Navigation Layer (导航层)
├── README.md (English)
└── README.zh-CN.md (中文)
```

---

## 📁 文件列表 (File List)

### Protocol Architecture Prompts (协议架构提示词)

| 文件 | 行数 | 大小 | 描述 |
|------|------|------|------|
| `data-protocol.prompt.md` | 371 | 11KB | ObjectQL 数据层协议 |
| `ui-protocol.prompt.md` | 559 | 15KB | ObjectUI 表现层协议 |
| `system-protocol.prompt.md` | 588 | 17KB | ObjectOS 运行时协议 |
| `ai-protocol.prompt.md` | 516 | 15KB | AI 集成协议 |
| `api-protocol.prompt.md` | 556 | 15KB | API 契约协议 |

### Development Role Prompts (角色提示词)

| 文件 | 行数 | 大小 | 描述 |
|------|------|------|------|
| `testing-engineer.prompt.md` | 386 | 9.8KB | 测试工程师角色 |
| `documentation-writer.prompt.md` | 471 | 11KB | 文档编写者角色 |
| `example-creator.prompt.md` | 600 | 14KB | 示例创建者角色 |

### Index Files (索引文件)

| 文件 | 行数 | 大小 | 描述 |
|------|------|------|------|
| `README.md` | 371 | 9.7KB | 英文导航索引 |
| `README.zh-CN.md` | 293 | 6.9KB | 中文导航索引 |

### Legacy Files (遗留文件)

| 文件 | 行数 | 大小 | 描述 |
|------|------|------|------|
| `schema.prompt.md` | 182 | 6.2KB | 原有提示词(保留兼容) |

---

## 🎯 每个提示词包含的内容

### 1. 角色定义 (Role Definition)
- **角色名称**: 明确的职位头衔
- **上下文**: 工作环境和范围
- **位置**: 相关代码目录

### 2. 核心职责 (Core Responsibilities)
- **协议定义**: 需要定义的模式
- **代码示例**: 完整的实现模式
- **标准结构**: 推荐的结构模板

### 3. 编码标准 (Coding Standards)
- **命名约定**: camelCase vs snake_case
- **Zod 模式**: 验证和类型推断
- **文档要求**: TSDoc 注释规范

### 4. 交互命令 (Interaction Commands)
- **快速命令**: 常见任务的快捷方式
- **示例**: "创建字段协议" → 实现完整的字段定义

### 5. 最佳实践 (Best Practices)
- **设计原则**: 严格类型、可扩展性
- **参考标准**: Salesforce、ServiceNow、Kubernetes
- **质量要求**: 测试覆盖率、文档完整性

### 6. 参考资源 (Reference Resources)
- **现有代码**: 当前实现链接
- **示例应用**: CRM、Todo 等完整示例
- **外部文档**: 相关规范和标准

---

## 🚀 使用方式 (Usage)

### GitHub Copilot 集成

这些提示词会被 GitHub Copilot 自动加载:

```
.github/
└── prompts/
├── data-protocol.prompt.md ← 编辑数据协议时自动加载
├── ui-protocol.prompt.md ← 编辑UI协议时自动加载
├── system-protocol.prompt.md ← 编辑系统协议时自动加载
└── ...
```

### 手动使用

1. **选择合适的提示词**: 根据任务选择对应的提示词文件
2. **阅读核心职责**: 了解该角色的主要工作内容
3. **参考代码示例**: 学习推荐的实现模式
4. **使用快速命令**: 通过命令快速完成任务

### 开发工作流

```
设计阶段 → 使用协议架构师提示词
实现阶段 → 遵循编码标准和模式
测试阶段 → 使用测试工程师提示词
文档阶段 → 使用文档编写者提示词
示例阶段 → 使用示例创建者提示词
```

---

## 📊 覆盖范围 (Coverage)

### 协议层覆盖 ✅

| 协议层 | 状态 | 文件 | 内容 |
|--------|------|------|------|
| 数据协议 | ✅ 完成 | `data-protocol.prompt.md` | 8个子协议(字段、对象、验证等) |
| UI协议 | ✅ 完成 | `ui-protocol.prompt.md` | 8个子协议(视图、应用、仪表板等) |
| 系统协议 | ✅ 完成 | `system-protocol.prompt.md` | 9个子协议(清单、插件、驱动等) |
| AI协议 | ✅ 完成 | `ai-protocol.prompt.md` | 7个子协议(代理、工具、知识库等) |
| API协议 | ✅ 完成 | `api-protocol.prompt.md` | 8个子协议(契约、请求、响应等) |

### 角色覆盖 ✅

| 角色 | 状态 | 文件 | 职责 |
|------|------|------|------|
| 协议架构师 | ✅ 5个 | `*-protocol.prompt.md` | 定义各层协议 |
| 测试工程师 | ✅ 完成 | `testing-engineer.prompt.md` | 编写测试 |
| 文档编写者 | ✅ 完成 | `documentation-writer.prompt.md` | 编写文档 |
| 示例创建者 | ✅ 完成 | `example-creator.prompt.md` | 创建示例 |

### 语言覆盖 ✅

| 语言 | 状态 | 文件 | 说明 |
|------|------|------|------|
| English | ✅ 完成 | `README.md` + all prompts | 完整英文文档 |
| 简体中文 | ✅ 完成 | `README.zh-CN.md` + this file | 中文导航和说明 |

---

## 📈 统计数据 (Statistics)

### 内容统计

- **提示词文件数**: 10个新文件
- **索引文件数**: 2个(中英文)
- **总行数**: 4,893行
- **总大小**: ~150KB
- **代码示例**: 100+ 个
- **交互命令**: 50+ 个

### 覆盖统计

- **协议层**: 5个核心协议层,全部覆盖
- **子协议**: 40+ 个子协议定义
- **开发角色**: 8个专业角色
- **编码模式**: 完整的 Zod-first 模式
- **最佳实践**: 全面的设计原则和标准

---

## 🎓 学习路径 (Learning Path)

### 初学者 (Beginner)

1. 阅读 `README.md` 了解整体结构
2. 从 `data-protocol.prompt.md` 开始学习基础
3. 参考 `example-creator.prompt.md` 查看完整示例
4. 使用 `testing-engineer.prompt.md` 学习测试

### 中级开发者 (Intermediate)

1. 深入学习各个协议层的提示词
2. 理解 `system-protocol.prompt.md` 的插件机制
3. 学习 `ui-protocol.prompt.md` 的服务器驱动UI
4. 实践 `api-protocol.prompt.md` 的契约定义

### 高级开发者 (Advanced)

1. 掌握 `ai-protocol.prompt.md` 的AI集成
2. 学习所有协议的协同工作方式
3. 贡献新的提示词和最佳实践
4. 参与协议标准的演进

---

## 🤝 贡献 (Contributing)

想要添加新的提示词?

1. **参考现有模板**: 使用现有提示词作为模板
2. **定义清晰范围**: 明确角色和职责
3. **包含完整示例**: 提供实际可用的代码示例
4. **更新索引**: 在 README 中添加链接
5. **提交PR**: 遵循代码审查清单

---

## 📞 获取帮助 (Get Help)

- **Discord**: https://discord.gg/objectstack
- **GitHub Issues**: https://github.com/objectstack-ai/spec/issues
- **文档**: https://docs.objectstack.ai

---

## ✨ 总结 (Summary)

我们成功创建了一套**完整的AI提示词系统**,包括:

✅ **5个协议层提示词** - 覆盖所有核心协议
✅ **3个角色提示词** - 支持完整开发流程
✅ **2个导航索引** - 中英文双语支持
✅ **4,893行文档** - 详细的指导和示例
✅ **100+代码示例** - 实际可用的实现模式

这套提示词系统将帮助开发者:
- 🚀 快速理解 ObjectStack 协议
- 💡 遵循最佳实践和编码标准
- 🎯 高效完成开发任务
- 📚 获得即时的上下文帮助

---

**创建日期**: 2026-01-21
**版本**: 1.0.0
**维护者**: ObjectStack Team

---

🎉 **所有AI提示词已生成完成!**
Loading
Loading