Skip to content

Commit 6b750f5

Browse files
Copilothuangyiirene
andcommitted
Add visual overview document for all AI prompts
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent aa5c8a4 commit 6b750f5

1 file changed

Lines changed: 273 additions & 0 deletions

File tree

.github/prompts/OVERVIEW.md

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
1+
# 🎯 ObjectStack AI Prompts - Complete Overview
2+
3+
## 生成的所有AI提示词 (All Generated AI Prompts)
4+
5+
本文档总结了为 ObjectStack 规范仓库生成的所有 AI 提示词。
6+
7+
---
8+
9+
## 📊 提示词架构 (Prompt Architecture)
10+
11+
```
12+
ObjectStack AI Prompts
13+
14+
├── 🏗️ Protocol Architecture Layer (协议架构层)
15+
│ ├── 📊 Data Protocol (数据协议)
16+
│ │ └── 定义 ObjectQL:字段、对象、验证、权限、工作流
17+
│ │
18+
│ ├── 🎨 UI Protocol (UI协议)
19+
│ │ └── 定义 ObjectUI:视图、应用、仪表板、报表
20+
│ │
21+
│ ├── ⚙️ System Protocol (系统协议)
22+
│ │ └── 定义 ObjectOS:清单、插件、驱动、身份认证
23+
│ │
24+
│ ├── 🤖 AI Protocol (AI协议)
25+
│ │ └── 定义 AI集成:代理、工具、知识库、对话
26+
│ │
27+
│ └── 🌐 API Protocol (API协议)
28+
│ └── 定义 API契约:请求、响应、错误、端点
29+
30+
├── 👥 Development Roles Layer (开发角色层)
31+
│ ├── 🧪 Testing Engineer (测试工程师)
32+
│ │ └── 编写测试、提高覆盖率、验证模式
33+
│ │
34+
│ ├── 📚 Documentation Writer (文档编写者)
35+
│ │ └── 编写文档、添加注释、创建教程
36+
│ │
37+
│ └── 💡 Example Creator (示例创建者)
38+
│ └── 创建示例、演示应用、参考实现
39+
40+
└── 📖 Navigation Layer (导航层)
41+
├── README.md (English)
42+
└── README.zh-CN.md (中文)
43+
```
44+
45+
---
46+
47+
## 📁 文件列表 (File List)
48+
49+
### Protocol Architecture Prompts (协议架构提示词)
50+
51+
| 文件 | 行数 | 大小 | 描述 |
52+
|------|------|------|------|
53+
| `data-protocol.prompt.md` | 371 | 11KB | ObjectQL 数据层协议 |
54+
| `ui-protocol.prompt.md` | 559 | 15KB | ObjectUI 表现层协议 |
55+
| `system-protocol.prompt.md` | 588 | 17KB | ObjectOS 运行时协议 |
56+
| `ai-protocol.prompt.md` | 516 | 15KB | AI 集成协议 |
57+
| `api-protocol.prompt.md` | 556 | 15KB | API 契约协议 |
58+
59+
### Development Role Prompts (角色提示词)
60+
61+
| 文件 | 行数 | 大小 | 描述 |
62+
|------|------|------|------|
63+
| `testing-engineer.prompt.md` | 386 | 9.8KB | 测试工程师角色 |
64+
| `documentation-writer.prompt.md` | 471 | 11KB | 文档编写者角色 |
65+
| `example-creator.prompt.md` | 600 | 14KB | 示例创建者角色 |
66+
67+
### Index Files (索引文件)
68+
69+
| 文件 | 行数 | 大小 | 描述 |
70+
|------|------|------|------|
71+
| `README.md` | 371 | 9.7KB | 英文导航索引 |
72+
| `README.zh-CN.md` | 293 | 6.9KB | 中文导航索引 |
73+
74+
### Legacy Files (遗留文件)
75+
76+
| 文件 | 行数 | 大小 | 描述 |
77+
|------|------|------|------|
78+
| `schema.prompt.md` | 182 | 6.2KB | 原有提示词(保留兼容) |
79+
80+
---
81+
82+
## 🎯 每个提示词包含的内容
83+
84+
### 1. 角色定义 (Role Definition)
85+
- **角色名称**: 明确的职位头衔
86+
- **上下文**: 工作环境和范围
87+
- **位置**: 相关代码目录
88+
89+
### 2. 核心职责 (Core Responsibilities)
90+
- **协议定义**: 需要定义的模式
91+
- **代码示例**: 完整的实现模式
92+
- **标准结构**: 推荐的结构模板
93+
94+
### 3. 编码标准 (Coding Standards)
95+
- **命名约定**: camelCase vs snake_case
96+
- **Zod 模式**: 验证和类型推断
97+
- **文档要求**: TSDoc 注释规范
98+
99+
### 4. 交互命令 (Interaction Commands)
100+
- **快速命令**: 常见任务的快捷方式
101+
- **示例**: "创建字段协议" → 实现完整的字段定义
102+
103+
### 5. 最佳实践 (Best Practices)
104+
- **设计原则**: 严格类型、可扩展性
105+
- **参考标准**: Salesforce、ServiceNow、Kubernetes
106+
- **质量要求**: 测试覆盖率、文档完整性
107+
108+
### 6. 参考资源 (Reference Resources)
109+
- **现有代码**: 当前实现链接
110+
- **示例应用**: CRM、Todo 等完整示例
111+
- **外部文档**: 相关规范和标准
112+
113+
---
114+
115+
## 🚀 使用方式 (Usage)
116+
117+
### GitHub Copilot 集成
118+
119+
这些提示词会被 GitHub Copilot 自动加载:
120+
121+
```
122+
.github/
123+
└── prompts/
124+
├── data-protocol.prompt.md ← 编辑数据协议时自动加载
125+
├── ui-protocol.prompt.md ← 编辑UI协议时自动加载
126+
├── system-protocol.prompt.md ← 编辑系统协议时自动加载
127+
└── ...
128+
```
129+
130+
### 手动使用
131+
132+
1. **选择合适的提示词**: 根据任务选择对应的提示词文件
133+
2. **阅读核心职责**: 了解该角色的主要工作内容
134+
3. **参考代码示例**: 学习推荐的实现模式
135+
4. **使用快速命令**: 通过命令快速完成任务
136+
137+
### 开发工作流
138+
139+
```
140+
设计阶段 → 使用协议架构师提示词
141+
142+
实现阶段 → 遵循编码标准和模式
143+
144+
测试阶段 → 使用测试工程师提示词
145+
146+
文档阶段 → 使用文档编写者提示词
147+
148+
示例阶段 → 使用示例创建者提示词
149+
```
150+
151+
---
152+
153+
## 📊 覆盖范围 (Coverage)
154+
155+
### 协议层覆盖 ✅
156+
157+
| 协议层 | 状态 | 文件 | 内容 |
158+
|--------|------|------|------|
159+
| 数据协议 | ✅ 完成 | `data-protocol.prompt.md` | 8个子协议(字段、对象、验证等) |
160+
| UI协议 | ✅ 完成 | `ui-protocol.prompt.md` | 8个子协议(视图、应用、仪表板等) |
161+
| 系统协议 | ✅ 完成 | `system-protocol.prompt.md` | 9个子协议(清单、插件、驱动等) |
162+
| AI协议 | ✅ 完成 | `ai-protocol.prompt.md` | 7个子协议(代理、工具、知识库等) |
163+
| API协议 | ✅ 完成 | `api-protocol.prompt.md` | 8个子协议(契约、请求、响应等) |
164+
165+
### 角色覆盖 ✅
166+
167+
| 角色 | 状态 | 文件 | 职责 |
168+
|------|------|------|------|
169+
| 协议架构师 | ✅ 5个 | `*-protocol.prompt.md` | 定义各层协议 |
170+
| 测试工程师 | ✅ 完成 | `testing-engineer.prompt.md` | 编写测试 |
171+
| 文档编写者 | ✅ 完成 | `documentation-writer.prompt.md` | 编写文档 |
172+
| 示例创建者 | ✅ 完成 | `example-creator.prompt.md` | 创建示例 |
173+
174+
### 语言覆盖 ✅
175+
176+
| 语言 | 状态 | 文件 | 说明 |
177+
|------|------|------|------|
178+
| English | ✅ 完成 | `README.md` + all prompts | 完整英文文档 |
179+
| 简体中文 | ✅ 完成 | `README.zh-CN.md` + this file | 中文导航和说明 |
180+
181+
---
182+
183+
## 📈 统计数据 (Statistics)
184+
185+
### 内容统计
186+
187+
- **提示词文件数**: 10个新文件
188+
- **索引文件数**: 2个(中英文)
189+
- **总行数**: 4,893行
190+
- **总大小**: ~150KB
191+
- **代码示例**: 100+ 个
192+
- **交互命令**: 50+ 个
193+
194+
### 覆盖统计
195+
196+
- **协议层**: 5个核心协议层,全部覆盖
197+
- **子协议**: 40+ 个子协议定义
198+
- **开发角色**: 8个专业角色
199+
- **编码模式**: 完整的 Zod-first 模式
200+
- **最佳实践**: 全面的设计原则和标准
201+
202+
---
203+
204+
## 🎓 学习路径 (Learning Path)
205+
206+
### 初学者 (Beginner)
207+
208+
1. 阅读 `README.md` 了解整体结构
209+
2.`data-protocol.prompt.md` 开始学习基础
210+
3. 参考 `example-creator.prompt.md` 查看完整示例
211+
4. 使用 `testing-engineer.prompt.md` 学习测试
212+
213+
### 中级开发者 (Intermediate)
214+
215+
1. 深入学习各个协议层的提示词
216+
2. 理解 `system-protocol.prompt.md` 的插件机制
217+
3. 学习 `ui-protocol.prompt.md` 的服务器驱动UI
218+
4. 实践 `api-protocol.prompt.md` 的契约定义
219+
220+
### 高级开发者 (Advanced)
221+
222+
1. 掌握 `ai-protocol.prompt.md` 的AI集成
223+
2. 学习所有协议的协同工作方式
224+
3. 贡献新的提示词和最佳实践
225+
4. 参与协议标准的演进
226+
227+
---
228+
229+
## 🤝 贡献 (Contributing)
230+
231+
想要添加新的提示词?
232+
233+
1. **参考现有模板**: 使用现有提示词作为模板
234+
2. **定义清晰范围**: 明确角色和职责
235+
3. **包含完整示例**: 提供实际可用的代码示例
236+
4. **更新索引**: 在 README 中添加链接
237+
5. **提交PR**: 遵循代码审查清单
238+
239+
---
240+
241+
## 📞 获取帮助 (Get Help)
242+
243+
- **Discord**: https://discord.gg/objectstack
244+
- **GitHub Issues**: https://github.com/objectstack-ai/spec/issues
245+
- **文档**: https://docs.objectstack.ai
246+
247+
---
248+
249+
## ✨ 总结 (Summary)
250+
251+
我们成功创建了一套**完整的AI提示词系统**,包括:
252+
253+
**5个协议层提示词** - 覆盖所有核心协议
254+
**3个角色提示词** - 支持完整开发流程
255+
**2个导航索引** - 中英文双语支持
256+
**4,893行文档** - 详细的指导和示例
257+
**100+代码示例** - 实际可用的实现模式
258+
259+
这套提示词系统将帮助开发者:
260+
- 🚀 快速理解 ObjectStack 协议
261+
- 💡 遵循最佳实践和编码标准
262+
- 🎯 高效完成开发任务
263+
- 📚 获得即时的上下文帮助
264+
265+
---
266+
267+
**创建日期**: 2026-01-21
268+
**版本**: 1.0.0
269+
**维护者**: ObjectStack Team
270+
271+
---
272+
273+
🎉 **所有AI提示词已生成完成!**

0 commit comments

Comments
 (0)