添加初始文件结构

This commit is contained in:
sean
2025-05-15 11:45:58 +08:00
parent 132c4442d6
commit 56552d49c6
18 changed files with 1986 additions and 0 deletions

View File

@ -0,0 +1,93 @@
# [标签名] 应用协议
> **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
```
代码或特殊格式示例(如适用)
```
</标签名>