diff --git a/README.md b/README.md new file mode 100644 index 0000000..0181784 --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ +# PromptX + +PromptX是一个基于DPML(Deepractice Prompt Markup Language)的提示词管理框架,它提供了结构化、模块化的方式来构建和管理AI提示词。 + +## 快速开始 + +### 安装 + +#### 前置条件 + +- Node.js (建议版本 >= 14.0.0) + +PromptX是一个提示词框架,可以通过以下方式集成到您的项目中: + +#### 方式一:直接拷贝 + +```bash +# 下载或克隆PromptX +git clone https://github.com/yourusername/PromptX.git + +# 将PromptX目录拷贝到您的项目中 +cp -r PromptX /path/to/your/project/ +``` + +#### 方式二:Git Submodule(推荐) + +```bash +# 在您的项目根目录下添加PromptX作为submodule +git submodule add https://github.com/yourusername/PromptX.git PromptX + +# 初始化和更新submodule +git submodule update --init --recursive +``` + +### 基本使用 + +PromptX的基本使用流程: + +#### 步骤1:打开bootstrap.md文件 +```bash +# 查看角色引导文件 +cat PromptX/bootstrap.md +``` + +#### 步骤2:修改代入角色 +在bootstrap.md中修改角色引用,例如: +```markdown +@file://PromptX/domain/scrum/role/product-owner.role.md +``` + +#### 步骤3:将bootstrap.md作为系统提示词 +将修改后的bootstrap.md内容复制到您的AI系统的系统提示词中。 + +#### 步骤4:发出Action指令 +向AI发送指令: +``` +Action +``` + +AI将自动按照PromptX协议加载角色、思维模式、执行框架和记忆系统。 + +### 演示视频 + +观看PromptX使用演示: + + + +## 可使用角色 + +PromptX框架内置了多种专业角色,您可以直接使用: + +### 基础角色 +- **简单助手 (Assistant)** - `@file://PromptX/domain/assistant/assistant.role.md` + - 具备基础思考和记忆能力 + - 适合一般对话和信息处理任务 + - 包含完整的资源处理和记忆管理机制 + +### Scrum敏捷角色 +- **产品负责人 (Product Owner)** - `@file://PromptX/domain/scrum/role/product-owner.role.md` + - 具备产品规划、需求管理、优先级决策等能力 + - 擅长用户导向思维、数据驱动决策、敏捷协作 + +### DPML开发角色 +- **提示词开发者 (Prompt Developer)** - `@file://PromptX/domain/prompt/prompt-developer.role.md` + - 具备探索性、系统性和批判性思维能力 + - 擅长设计结构清晰的提示词,遵循DPML开发规范 + - 掌握思维模式、执行模式、记忆模式等各类提示词最佳实践 + +### 自定义角色 +您可以使用PromptX轻松创建自定义角色: + +1. 在bootstrap.md中引用提示词开发者角色: + ``` + @file://PromptX/domain/prompt/prompt-developer.role.md + ``` +2. 向提示词开发者AI发出新角色的需求描述 +3. AI将自动生成完整的角色定义文件 +4. 将生成的角色文件保存并在bootstrap.md中引用 + +这种方式让角色开发变得简单直观,无需手动编写复杂的角色结构。 + +## 更多资源 + +- [深度实践官网](https://www.deepracticex.com/) - AI智能协作平台 +- [DPML项目](https://github.com/Deepractice/dpml) - Deepractice Prompt Markup Language + +### AI 学习社区交流群 + +扫码添加作者微信,备注【加群】: + +作者微信 + + +## 许可证 + +MIT \ No newline at end of file diff --git a/assets/demo.mp4 b/assets/demo.mp4 new file mode 100644 index 0000000..9e11ae0 Binary files /dev/null and b/assets/demo.mp4 differ diff --git a/assets/qrcode.jpg b/assets/qrcode.jpg new file mode 100644 index 0000000..229435f Binary files /dev/null and b/assets/qrcode.jpg differ