158 lines
2.7 KiB
Markdown
158 lines
2.7 KiB
Markdown
# 模式协议定义模板
|
||
|
||
> **TL;DR:** 本文档提供了定义PromptX模式协议的标准模板，包含语法、语义、约束和示例等关键要素，确保协议定义的一致性和完整性。
|
||
|
||
## 🧠 模式协议定义框架
|
||
|
||
模式协议是PromptX中最基础的表达规则集，定义了"如何表达"的基本语法和语义。本模板提供了定义模式协议的标准结构。
|
||
|
||
### 基本信息部分
|
||
|
||
```markdown
|
||
# [协议名称] 模式协议
|
||
|
||
> **TL;DR:** [一句话描述协议的核心目的和价值]
|
||
|
||
## 🔍 协议概述
|
||
|
||
**协议名称:** [正式名称]
|
||
**版本:** [版本号，如1.0.0]
|
||
|
||
|
||
### 目的与范围
|
||
|
||
[详细描述此协议的目的、解决的问题和适用范围]
|
||
|
||
### 相关协议
|
||
|
||
[列出与本协议相关的其他协议及其关系]
|
||
```
|
||
|
||
### 语法规则部分
|
||
|
||
```markdown
|
||
## 📝 语法规则
|
||
|
||
### 形式化定义
|
||
|
||
```ebnf
|
||
[使用EBNF或类似形式语言描述语法]
|
||
```
|
||
|
||
### 词法元素
|
||
|
||
| 元素 | 形式 | 描述 |
|
||
|------|------|------|
|
||
| [元素名] | [表示形式] | [简要描述] |
|
||
| ... | ... | ... |
|
||
|
||
### 组合规则
|
||
|
||
1. [规则1]
|
||
2. [规则2]
|
||
3. ...
|
||
```
|
||
|
||
### 语义定义部分
|
||
|
||
```markdown
|
||
## 🧩 语义定义
|
||
|
||
### 核心概念
|
||
|
||
| 概念 | 定义 | 示例 |
|
||
|------|------|------|
|
||
| [概念1] | [定义描述] | [示例] |
|
||
| ... | ... | ... |
|
||
|
||
### 解释规则
|
||
|
||
[详细说明如何解释协议元素，以及解释过程中的优先级或特殊情况]
|
||
```
|
||
|
||
### 约束与验证部分
|
||
|
||
```markdown
|
||
## ✅ 约束与验证
|
||
|
||
### 必要约束
|
||
|
||
1. [约束1]
|
||
2. [约束2]
|
||
3. ...
|
||
|
||
### 验证规则
|
||
|
||
[说明如何验证协议实例的正确性]
|
||
|
||
### 错误处理
|
||
|
||
[说明遇到错误时应如何处理]
|
||
```
|
||
|
||
### 扩展机制部分
|
||
|
||
```markdown
|
||
## 🔄 扩展机制
|
||
|
||
### 扩展点
|
||
|
||
[描述协议可以被扩展的方式和位置]
|
||
|
||
### 扩展规则
|
||
|
||
[定义创建扩展时必须遵循的规则]
|
||
|
||
### 扩展示例
|
||
|
||
[提供扩展的具体示例]
|
||
```
|
||
|
||
### 使用示例部分
|
||
|
||
```markdown
|
||
## 📋 使用示例
|
||
|
||
### 有效示例
|
||
|
||
```
|
||
[提供3-5个有效使用的示例]
|
||
```
|
||
|
||
### 无效示例
|
||
|
||
```
|
||
[提供2-3个无效使用的示例及错误原因]
|
||
```
|
||
```
|
||
|
||
### 最佳实践部分
|
||
|
||
```markdown
|
||
## 💡 最佳实践
|
||
|
||
1. [最佳实践1]
|
||
2. [最佳实践2]
|
||
3. ...
|
||
|
||
### 常见问题
|
||
|
||
**Q: [常见问题1]**
|
||
A: [问题解答]
|
||
|
||
**Q: [常见问题2]**
|
||
A: [问题解答]
|
||
```
|
||
|
||
## 📊 协议定义检查清单
|
||
|
||
创建新的模式协议时，请确保包含以下内容：
|
||
|
||
- [ ] 基本信息完整（名称、版本、状态等）
|
||
- [ ] 目的和范围清晰定义
|
||
- [ ] 语法规则使用形式化方法描述
|
||
- [ ] 语义定义完整且示例充分
|
||
- [ ] 约束和验证规则明确
|
||
- [ ] 扩展机制详细说明
|
||
- [ ] 提供充分的有效和无效示例
|
||
- [ ] 包含最佳实践和常见问题解答 |