更新resource协议文档，增加子标签语义说明，详细描述location和params子标签的功能与结构，提升文档的清晰度和可读性。同时，删除不再使用的协议模板文件，优化代码库结构。
This commit is contained in:
sean
@ -1,93 +0,0 @@
|
||||
# [标签名] 应用协议
|
||||
|
||||
> **TL;DR:** [一句话描述此标签的核心用途与价值]
|
||||
|
||||
## 🔍 基本信息
|
||||
|
||||
**标签名:** `<标签名>`
|
||||
|
||||
|
||||
### 目的与功能
|
||||
|
||||
[详细描述此标签的目的、解决的问题和提供的功能]
|
||||
|
||||
## 🧰 设计原则
|
||||
|
||||
定义应用协议时，应当遵循以下核心设计原则：
|
||||
|
||||
1. **约定大于配置**：减少明确的配置需求，优先使用合理的默认约定
|
||||
2. **职责单一**：每个协议应专注于单一功能或目的，避免过度复杂
|
||||
3. **最小可行产品(MVP)**：从最核心功能开始，确保基础用例能够正常工作
|
||||
4. **奥卡姆剃刀原则**：在同等条件下，应选择最简单的设计方案
|
||||
5. **一致性**：保持与其他协议的设计风格和使用模式一致
|
||||
|
||||
这些原则有助于确保协议设计的简洁性、可用性和可维护性。
|
||||
|
||||
## 📝 语法定义
|
||||
|
||||
```ebnf
|
||||
(* EBNF形式化定义 *)
|
||||
tag_element ::= '<标签名' attributes? '>' content '</标签名>'
|
||||
attributes ::= (' ' attribute)+ | ''
|
||||
attribute ::= name '="' value '"'
|
||||
name ::= [a-zA-Z][a-zA-Z0-9_-]*
|
||||
value ::= [^"]*
|
||||
content ::= markdown_content
|
||||
markdown_content ::= (* 任何有效的Markdown文本，可包含特定语法元素 *)
|
||||
```
|
||||
|
||||
## 🧩 语义说明
|
||||
|
||||
此标签用于[描述标签的主要用途和语义]。在提示词中，它表示[...]并协助AI[...]。
|
||||
|
||||
## 💡 最佳实践
|
||||
|
||||
以下是使用此标签的一些建议做法，这些并非强制要求，仅作为参考：
|
||||
|
||||
### 推荐属性
|
||||
|
||||
可以考虑使用以下属性来增强标签的语义：
|
||||
|
||||
- **属性1**: [属性说明和示例值]
|
||||
- **属性2**: [属性说明和示例值]
|
||||
- **属性3**: [属性说明和示例值]
|
||||
|
||||
### 内容组织
|
||||
|
||||
推荐在标签内使用以下结构组织内容：
|
||||
|
||||
1. [内容组织建议1]
|
||||
2. [内容组织建议2]
|
||||
3. [内容组织建议3]
|
||||
|
||||
### 可视化表达（如适用）
|
||||
|
||||
[如适用，描述此标签内容的可视化表达方式，如图表类型、格式建议等]
|
||||
|
||||
### 扩展选项
|
||||
|
||||
根据MVP原则，标签应先实现核心功能。当核心功能稳定后，可考虑以下扩展方向：
|
||||
|
||||
1. **高级属性**：添加可选的高级配置属性，但确保基本功能不依赖这些属性
|
||||
2. **集成能力**：提供与其他标签或协议的集成接口
|
||||
3. **专业化变体**：为特定场景开发的专门版本或扩展
|
||||
4. **性能优化**：针对高频使用场景的性能改进
|
||||
|
||||
扩展时应保持向后兼容性，并避免增加不必要的复杂度。
|
||||
|
||||
## 📋 使用示例
|
||||
|
||||
<标签名 属性1="值1" 属性2="值2">
|
||||
# 示例内容标题
|
||||
|
||||
## 内容部分1
|
||||
示例内容描述
|
||||
|
||||
## 内容部分2
|
||||
- 要点1
|
||||
- 要点2
|
||||
|
||||
```
|
||||
代码或特殊格式示例（如适用）
|
||||
```
|
||||
</标签名>
|
||||
58
protocol/template/protocol-framework-template.md
Normal file
58
protocol/template/protocol-framework-template.md
Normal file
@ -0,0 +1,58 @@
|
||||
# DPML{协议名称}模式提示词框架
|
||||
|
||||
> **TL;DR:** DPML{协议名称}模式提示词框架定义了{一句话描述协议核心功能和价值}，{补充说明特点或独特价值}。
|
||||
|
||||
### 目的与功能
|
||||
|
||||
DPML{协议名称}模式提示词框架{详细说明此框架的目的}，它的主要功能是：
|
||||
- {功能点1}
|
||||
- {功能点2}
|
||||
- {功能点3}
|
||||
- {功能点4}
|
||||
|
||||
## 📝 语法定义
|
||||
|
||||
```ebnf
|
||||
(* EBNF形式化定义 *)
|
||||
{主标签}_element ::= '<{主标签}' attributes? '>' content '</{主标签}>'
|
||||
attributes ::= (' ' attribute)+ | ''
|
||||
attribute ::= name '="' value '"'
|
||||
name ::= [a-zA-Z][a-zA-Z0-9_-]*
|
||||
value ::= [^"]*
|
||||
content ::= (markdown_content | {子标签1}_element | {子标签2}_element | ... )+
|
||||
|
||||
{子标签1}_element ::= '<{子标签1}' attributes? '>' markdown_content '</{子标签1}>'
|
||||
{子标签2}_element ::= '<{子标签2}' attributes? '>' markdown_content '</{子标签2}>'
|
||||
...
|
||||
|
||||
markdown_content ::= (* 任何有效的Markdown文本，可包含特定语法元素 *)
|
||||
```
|
||||
|
||||
## 🧩 语义说明
|
||||
|
||||
{主标签}标签表示{对主标签的核心语义描述}。标签内容可以包含{数量}种不同{类型}的子标签，每个子标签都有明确的语义：
|
||||
|
||||
- **{子标签1}**: {子标签1的语义描述}
|
||||
- **{子标签2}**: {子标签2的语义描述}
|
||||
- **{子标签3}**: {子标签3的语义描述}
|
||||
- ...
|
||||
|
||||
{这些子标签的组合关系、层次结构或互操作方式}
|
||||
|
||||
{如有必要，对标签语义的补充说明}
|
||||
|
||||
### {补充语义说明1，如 "优先级关系"、"组合规则" 等}
|
||||
|
||||
{详细描述补充语义内容}
|
||||
|
||||
1. **{项目1}** - {描述}
|
||||
2. **{项目2}** - {描述}
|
||||
3. ...
|
||||
|
||||
{进一步说明这些补充语义的重要性或应用场景}
|
||||
|
||||
### {补充语义说明2，如 "子标签的可选性" 等}
|
||||
|
||||
{详细描述补充语义内容}
|
||||
|
||||
{说明这些补充语义如何影响理解和使用}
|
||||
@ -1,158 +0,0 @@
|
||||
# 模式协议定义模板
|
||||
|
||||
> **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: [问题解答]
|
||||
```
|
||||
|
||||
## 📊 协议定义检查清单
|
||||
|
||||
创建新的模式协议时，请确保包含以下内容：
|
||||
|
||||
- [ ] 基本信息完整（名称、版本、状态等）
|
||||
- [ ] 目的和范围清晰定义
|
||||
- [ ] 语法规则使用形式化方法描述
|
||||
- [ ] 语义定义完整且示例充分
|
||||
- [ ] 约束和验证规则明确
|
||||
- [ ] 扩展机制详细说明
|
||||
- [ ] 提供充分的有效和无效示例
|
||||
- [ ] 包含最佳实践和常见问题解答
|
||||
Reference in New Issue
Block a user