118 lines
3.6 KiB
Markdown
118 lines
3.6 KiB
Markdown
# PromptX 协议文档
|
||
|
||
> **TL;DR:** PromptX协议体系包含基础协议定义和最佳实践指南，为不同角色（框架开发者、提示词开发者、提示词理解者）提供相应的参考资料。
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
protocol/
|
||
├── base/ # 基础协议定义 - 语法和语义
|
||
│ ├── thought.protocol.md
|
||
│ ├── execution.protocol.md
|
||
│ ├── resource.protocol.md
|
||
│ ├── memory.protocol.md
|
||
│ └── ...
|
||
├── practice/ # 最佳实践指南 - 实际应用建议和示例
|
||
│ ├── thought-best-practice.md
|
||
│ ├── execution-best-practice.md
|
||
│ ├── resource-best-practice.md
|
||
│ ├── memory-best-practice.md
|
||
│ └── ...
|
||
├── template/ # 协议模板 - 用于创建新协议
|
||
│ ├── protocol-pattern-template.md
|
||
│ ├── protocol-application-template.md
|
||
│ └── ...
|
||
└── README.md # 本文件
|
||
```
|
||
|
||
## 角色定义与关注点
|
||
|
||
### 1. 框架开发者
|
||
|
||
**定义**：负责设计和维护DPML协议体系本身的开发人员。
|
||
|
||
**目标**：
|
||
- 设计一致且可扩展的协议体系
|
||
- 保证协议间的互操作性
|
||
- 优化协议的表达能力和效率
|
||
|
||
**应关注内容**：
|
||
- ✅ `base/` 所有协议定义
|
||
- ✅ `practice/` 所有最佳实践
|
||
- ✅ `template/` 所有协议模板
|
||
- ✅ 协议之间的依赖和互操作
|
||
|
||
### 2. 提示词开发者
|
||
|
||
**定义**：使用DPML框架开发具体提示词的工程师或设计师。
|
||
|
||
**目标**：
|
||
- 设计高质量、结构化的提示词
|
||
- 优化提示词的效果和性能
|
||
- 复用现有协议和最佳实践
|
||
|
||
**应关注内容**：
|
||
- ✅ `base/` 相关协议的语法和语义
|
||
- ✅ `practice/` 相关协议的最佳实践和示例
|
||
- ❌ 协议内部实现细节
|
||
|
||
### 3. 提示词理解者
|
||
|
||
**定义**：需要解析和执行DPML结构化提示词的系统或组件（如AI模型、解析器等）。
|
||
|
||
**目标**：
|
||
- 准确理解提示词的语法和语义
|
||
- 按预期执行提示词指令
|
||
|
||
**应关注内容**：
|
||
- ✅ `base/` 协议的语法定义和语义说明
|
||
- ❌ 最佳实践和设计建议
|
||
- ❌ 协议模板和开发方法
|
||
|
||
## 文档类型说明
|
||
|
||
### 协议文档 (`base/*.protocol.md`)
|
||
|
||
协议文档定义了"**是什么**"和"**如何理解**"：
|
||
- 语法定义：标签结构、属性、嵌套规则等
|
||
- 语义说明：各元素的含义和解释规则
|
||
- 子标签语义：子标签的功能和互操作方式
|
||
|
||
这些文档面向**所有角色**，但主要服务于**提示词理解者**，提供基础的语法和语义规范。
|
||
|
||
### 最佳实践文档 (`practice/*-best-practice.md`)
|
||
|
||
最佳实践文档探讨"**怎么用**"和"**用得更好**"：
|
||
- 设计建议：推荐的使用方法和模式
|
||
- 风格指南：推荐的表达风格和格式
|
||
- 实际示例：常见用例的具体实现
|
||
|
||
这些文档主要面向**提示词开发者**，帮助他们创建高质量的提示词。
|
||
|
||
### 模板文档 (`template/*.md`)
|
||
|
||
模板文档提供了"**如何创建新协议**"的指导：
|
||
- 结构模板：新协议的标准结构
|
||
- 内容要求：各节应包含的内容
|
||
- 验证清单：完整性与一致性检查
|
||
|
||
这些文档专门面向**框架开发者**，用于扩展协议体系。
|
||
|
||
## 使用指南
|
||
|
||
### 作为框架开发者
|
||
|
||
1. 参考 `template/` 下的模板创建新协议
|
||
2. 确保新协议与现有协议体系一致
|
||
3. 同时提供协议定义和最佳实践文档
|
||
|
||
### 作为提示词开发者
|
||
|
||
1. 首先阅读相关协议的语法和语义 (`base/`)
|
||
2. 参考最佳实践和示例 (`practice/`)
|
||
3. 按协议规范构建提示词
|
||
|
||
### 作为提示词理解者
|
||
|
||
1. 重点关注协议的语法定义和语义说明 (`base/`)
|
||
2. 按规范解析和处理提示词 |