diff --git a/README.md b/README.md index 702bdfd..906059c 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,407 @@ PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和 您的反馈对我们非常宝贵,帮助我们快速改进产品质量! ✨ +### 🤔 **常见问题解答** *(点击问题展开查看详细解答)* + +#### ⚡ **P0 高优先级 - 必须解决的问题** + +
+Q1: 如何判断PromptX是否安装成功? 👆 + +> **判断标准很简单:看你的AI应用是否能加载出PromptX的MCP工具** + +> ### ✅ 安装成功的标志: +> PromptX安装成功 - MCP工具正常加载 +> +> 当你看到以下MCP工具出现时,说明PromptX已成功安装: +> - `promptx_init` - 初始化PromptX工作环境 +> - `promptx_welcome` - 发现可用的专业角色 +> - `promptx_action` - 激活指定的专业角色 +> - `promptx_recall` - 回忆历史记忆内容 +> - `promptx_remember` - 保存重要信息到记忆 + +> ### ❌ 安装失败的表现: +> PromptX安装失败 - MCP工具无法加载 +> +> 如果重启AI应用后看不到上述工具,说明安装配置有问题。 + +> ### 🔧 解决方案: +> 1. **检查Node.js版本**:确保已安装Node.js v18及以上版本 +> 2. **重新检查配置**:确保JSON格式正确,没有多余的逗号或括号 +> 3. **清除缓存重试**:删除npm缓存后重新配置 `npm cache clean --force` +> 4. **查看错误日志**:AI应用通常会显示MCP连接错误的具体信息 + +
+ +
+Q2: 安装失败详细检查和解决方案 👆 + +> 如果Q1的基础检查仍无法解决问题,请按以下步骤进行深度排查: + +> ### 🔍 Step 1: 确认Node.js环境 +> ```bash +> node --version # 确保v18及以上版本 +> npx --version # 确保npx可用 +> ``` + +> ### 🔍 Step 2: 测试PromptX包是否可访问 +> ```bash +> npx -y -f --registry https://registry.npmjs.org dpml-prompt@beta -v +> ``` +> 如果能正常显示版本号,说明包访问正常。如果报错,继续下一步。 + +> ### 🔍 Step 3: 深度清理缓存和冲突包 +> +> 如果上述测试失败,请使用以下AI提示词获取专业帮助: +> +> ``` +> 使用这个 PromptX MCP 的时候有一定的问题,我在命令行执行启动也不能成功,我怀疑是版本或者缓存的问题,我们需要考虑 snapshot 是否不存在于我电脑的 npm 镜像仓库,还有我本地的 npx缓存是否清理干净,最后可能还有历史遗留的问题是 一个包名为 dpml 的包和这个项目有冲突也需要清理掉。另外就是近期这个项目从 snapshot 迁移到了 beta 版本,也要检查下这两个版本之间是否有缓存干扰 +> ``` + +> ### 💡 常见解决方案预览: +> - 清理npm和npx缓存:`npm cache clean --force` +> - 移除冲突的旧版本dpml包 +> - 清理snapshot版本的缓存残留 +> - 重新配置镜像源和版本号 +> +> **📋 相关Issue:** [#61](https://github.com/Deepractice/PromptX/issues/61) - 详细的故障排除案例 + +
+ +
+Q3: 配置正确但AI不理解我想激活角色的意图? 👆 + +> 这是使用习惯问题,不是技术故障。请记住:**把AI当人,不是软件** + +> ### ❌ 错误的命令式思维: +> ``` +> "执行promptx_action java-developer" +> "运行角色激活命令" +> "如何正确使用角色激活功能?" +> ``` + +> ### ✅ 正确的对话式交流: +> ``` +> "我需要一个Java开发专家" +> "帮我找个懂Python的大牛" +> "我要和产品经理聊聊需求" +> "切换到数据分析师模式" +> ``` + +> ### 💡 核心原则: +> 自然表达你的需求,AI会理解你的意图并自动调用相应的MCP工具。 + +
+ +#### 🔥 **P1 中高优先级 - 影响功能使用** + +
+Q4: 女娲创建角色后无法激活怎么办? 👆 + +> ### 🔧 角色激活原理: +> +> PromptX角色激活需要两个步骤: +> 1. **发现角色资源** - 使用`init`工具扫描并注册新创建的角色 +> 2. **激活角色** - 从注册表中调用指定角色 + +> ### 🚨 常见问题及解决方案: + +> #### 问题1:女娲忘记执行资源注册 +> +> **现象:** 女娲提示"角色创建完成",但尝试激活时提示"角色不存在" +> +> **原因:** 女娲创建了角色文件,但忘记执行`init`工具将角色注册到系统中 +> +> **解决方案:** +> ``` +> 直接提醒女娲:"请执行init工具注册刚才创建的角色" +> 或者说:"女娲你忘记注册角色了,请使用init工具" +> ``` + +> #### 问题2:执行了init工具仍无法激活 +> +> **现象:** +> - 女娲已执行`init`工具 +> - 提示"注册成功" +> - 但激活时仍提示"角色不存在" +> +> **原因:** 触发了角色注册缓存bug(已知问题,正在修复中) +> +> **解决方案:** +> ``` +> 重启你的AI应用(Claude Desktop/Cursor等) +> 重启后角色应该可以正常激活 +> ``` + +> ### 🎯 最佳实践流程: +> +> 1. **女娲创建角色** → 等待创建完成提示 +> 2. **提醒执行注册** → "女娲请执行init工具注册角色" +> 3. **尝试激活角色** → "激活刚才创建的XX角色" +> 4. **如仍失败** → 重启AI应用后重试 + +> ### 📋 开发团队说明: +> +> 我们已经识别到这个缓存相关的bug,正在积极寻找根本原因并开发修复方案。在正式修复前,重启AI应用是最可靠的临时解决方案。 +> +> 感谢您的理解和耐心! 🙏 + +
+ +
+Q5: 角色激活后能持续多久?需要重新激活吗? 👆 + +**角色激活是会话级别的,具体持续时间取决于你使用的AI应用:** + +- **Claude Desktop**: 角色在当前对话窗口内持续有效,新开对话需要重新激活 +- **Cursor**: 角色在当前工作会话内有效,重启应用需要重新激活 +- **其他MCP客户端**: 根据具体应用的会话管理机制而定 + +**🎯 最佳实践:** +- 当你发现AI回复风格变回普通模式时,说明角色状态可能已失效 +- 直接说"继续以XX专家身份帮我"即可快速重新激活 +- 重要项目建议在对话开始时先激活对应的专业角色 + +
+ +#### 📋 **P2 中优先级 - 用户价值和期望管理** + +
+Q6: PromptX角色与全局提示词(claude.md/cursorrules)的关系 👆 + +**🏛️ 理解优先级关系:法律 vs 公司规章制度** + +可以用这个类比来理解: +- **全局提示词** (claude.md/cursorrules) = **法律** - 最高优先级,不可违背 +- **PromptX角色** = **公司规章制度** - 在法律框架内的专业规范 + +**⚖️ 冲突处理机制:** + +当两者发生冲突时,AI会优先遵守全局提示词的规则,这意味着: + +``` +✅ 正常情况:全局规则 + PromptX角色 = 完美协作 +❌ 冲突情况:全局规则覆盖PromptX角色行为 +``` + +**🎯 最佳实践建议:** + +1. **避免逻辑冲突** + ``` + ❌ 全局规则:"总是使用英文回复" + ❌ PromptX角色:"我是中文技术专家" + → 结果:AI会优先使用英文,角色功能受限 + + ✅ 全局规则:"保持代码质量" + ✅ PromptX角色:"我是Java开发专家" + → 结果:完美配合,既保证质量又有专业能力 + ``` + +2. **互补而非竞争** + - 全局规则处理通用约束(安全、格式、行为规范) + - PromptX角色提供专业能力(领域知识、工作流程) + +**🎨 PromptX的设计哲学:** + +> **"内聚独立,和谐共存"** + +- **内聚性**:PromptX角色自包含完整的专业能力,不依赖外部全局规则 +- **独立性**:可在任何全局提示词环境下正常工作 +- **兼容性**:设计时避免与常见全局规则产生冲突 +- **专业性**:专注于提供领域专业能力,而非修改基础AI行为 + +**💡 实用建议:** + +- **检查兼容性**:激活PromptX角色前,确认与你的全局规则无逻辑冲突 +- **分层管理**:全局规则管基础约束,PromptX管专业技能 +- **测试验证**:首次使用时观察AI行为,确保两套规则协调工作 +- **优先全局**:如发现冲突,优先调整PromptX使用方式而非全局规则 + +
+ +
+Q7: PromptX官方提供的角色都有什么用? 👆 + +**🎭 PromptX官方内置角色全览:** + +### 🏗️ **创作工坊系列** + +#### **👸 女娲 (nuwa) - 角色创造大师** 🧪 *公测版* +- **核心功能**:AI角色设计师,2分钟创建专业AI助手 +- **使用场景**:需要定制专业角色时使用 +- **激活方式**:"我要女娲帮我创建角色" +- **特色**:零门槛创造,从想法到可用角色全程自动化 +- **状态**:功能相对稳定,适合日常使用 + +#### **🔧 鲁班 (luban) - 工具开发专家** ⚡ *内测版* +- **核心功能**:MCP工具开发和技术实现专家 +- **使用场景**:需要开发自定义工具时使用 +- **激活方式**:"激活鲁班工具开发专家" +- **特色**:掌握ToolSandbox技术,快速开发MCP工具 +- **状态**:核心功能可用,工具开发流程持续优化中 + +#### **👤 无面 (noface) - 万能代入角色** ⚡ *内测版* +- **核心功能**:读取本地提示词文件并即时代入 +- **使用场景**:使用现有提示词,保持原有习惯 +- **激活方式**:"激活noface无面角色" +- **特色**:零改动集成现有提示词库 +- **状态**:核心功能可用,部分特性持续完善中 + +### 🧠 **思维决策系列** + +#### **🎯 Sean - Deepractice创始人 & PromptX Maintainer** 🧪 *公测版* +- **核心功能**:与Sean直接沟通的渠道,提供产品反馈和合作讨论 +- **使用场景**:提意见、聊合作、报告bug、产品建议、战略讨论 +- **激活方式**:"我想和Sean聊聊" 或 "激活Sean" +- **特色**:打通用户与创始人的直接沟通,矛盾分析思维加持 +- **状态**:功能稳定,是用户与PromptX团队沟通的重要桥梁 + +#### **🤖 Assistant - 智能助手** 🧪 *公测版* +- **核心功能**:通用AI助手,提供基础专业服务 +- **使用场景**:日常任务处理和通用咨询 +- **激活方式**:"激活assistant助手" +- **特色**:平衡的能力配置,适合多场景使用 +- **状态**:基础稳定,推荐新手使用 + +### 🔍 **感知分析系列** + +#### **👁️ 觉知者 (awareness) - 体验评估专家** ⚡ *内测版* +- **核心功能**:提示词体验评估和认知分析 +- **使用场景**:评估和优化AI交互体验 +- **激活方式**:"激活觉知者角色" +- **特色**:专注于用户体验和认知体验的深度分析 +- **状态**:实验性功能,欢迎反馈使用体验 + +### 💡 **选择建议:** + +**🎯 新手推荐路径(稳定优先):** +1. **Assistant** - 从最稳定的基础助手开始 🧪 +2. **女娲** - 创建适合自己领域的专业角色 🧪 +3. **Sean** - 与创始人沟通,获取产品支持 🧪 + +**🚀 进阶用户路径(功能探索):** +1. **无面快速集成** - 使用现有提示词库 ⚡ +2. **鲁班开发工具** - 扩展PromptX功能边界 ⚡ +3. **觉知者优化体验** - 评估和改进AI使用效果 ⚡ + +**📊 按稳定性选择:** +- **日常使用** → 推荐使用 🧪 公测版角色(Assistant、女娲、Sean) +- **尝鲜体验** → 欢迎试用 ⚡ 内测版角色(鲁班、无面、觉知者) + +**🔄 角色组合使用:** +- **基础组合**:Assistant + Sean - 日常助手+创始人沟通 +- **创作组合**:女娲 + 鲁班 - 创建角色+开发工具(鲁班为内测功能) +- **体验组合**:无面 + 觉知者 - 快速集成+体验优化 + +**💬 与Sean直接沟通的价值:** +- **产品反馈** - 直接向创始人提供使用建议和改进意见 +- **合作探讨** - 讨论潜在的商业合作和技术合作机会 +- **bug报告** - 快速向维护者报告技术问题 +- **战略讨论** - 基于矛盾分析方法论的深度思考交流 + +**⚠️ 内测角色使用提醒:** +- 内测角色可能存在不稳定情况,建议在非关键任务中试用 +- 欢迎向我们反馈使用体验,帮助改进产品质量 + +
+ +#### 📚 **P3 低优先级 - 扩展功能和未来规划** + +
+Q8: 我有自己的提示词库,如何集成到PromptX中? 👆 + +**🎯 两种集成方案,满足不同需求:** + +**方案一:女娲转换法 - 永久集成** + +**适用场景:** 希望将提示词永久转换为PromptX标准角色 + +**操作步骤:** +1. **激活女娲** - "我要女娲帮我转换提示词" +2. **提供提示词** - 将你的提示词内容发给女娲 +3. **女娲转换** - 女娲会将其转换为符合DPML标准的PromptX角色 +4. **注册激活** - 转换完成后可直接激活使用 + +**优势:** +- ✅ 永久保存为PromptX角色 +- ✅ 享受完整的PromptX生态功能 +- ✅ 可以进一步优化和定制 + +**方案二:无面角色 - 即时代入(内测)** + +**适用场景:** 保持原有使用习惯,不想改变现有提示词 + +**操作步骤:** +1. **激活无面角色** - "激活noface无面角色" +2. **提供文件路径** - 告诉无面你的提示词文件位置 +3. **即时代入** - 无面会读取并立即代入该提示词 +4. **保持习惯** - 继续按原有方式使用提示词 + +**优势:** +- ✅ 零改动,保持原有使用习惯 +- ✅ 支持动态切换不同提示词文件 +- ✅ 不需要学习PromptX角色格式 +- ✅ 可以同时享受PromptX的记忆等功能 + +**🔄 方案对比:** + +| 特性 | 女娲转换法 | 无面角色 | +|------|------------|----------| +| **集成方式** | 永久转换 | 即时代入 | +| **学习成本** | 需了解PromptX | 零学习成本 | +| **使用习惯** | 需适应新方式 | 保持原习惯 | +| **功能完整性** | 完整PromptX功能 | 基础功能+记忆 | +| **维护更新** | 需重新转换 | 直接修改文件 | + +**💡 建议选择:** +- **新手用户** → 推荐无面角色,零门槛开始 +- **深度用户** → 推荐女娲转换,享受完整功能 +- **团队协作** → 推荐女娲转换,统一角色标准 +- **快速试用** → 推荐无面角色,立即体验 + +**🔔 注意事项:** +- 无面角色目前处于内测阶段,功能持续完善中 +- 文件路径需要是AI应用可访问的本地路径 +- 建议先用无面角色体验,确认效果后再考虑女娲转换 + +
+ +
+Q9: PromptX支持HTTP版本的MCP吗? 👆 + +**📋 当前状态:暂不推荐使用** + +PromptX目前支持HTTP版本的MCP协议,但由于当前架构设计的限制,HTTP版本的稳定性和功能完整性还不够理想。 + +**⚠️ 现阶段建议:** +- **推荐使用**:标准MCP协议版本(当前配置方式) +- **暂不推荐**:HTTP MCP版本 + +**🚀 7月份重大更新计划:** + +我们计划在7月份进行重大架构升级,届时将: + +1. **🏗️ 架构重构** - 全面优化底层架构,完善HTTP MCP支持 +2. **🌐 官方平台** - 部署官方平台版本,提供云端服务 +3. **📱 更多渠道** - 支持更多AI应用和使用场景 +4. **⚡ 性能提升** - HTTP版本将获得与标准版本同等的性能表现 + +**💡 为什么要等架构升级?** + +- **稳定性优先** - 确保为用户提供最佳使用体验 +- **功能完整性** - HTTP版本将获得完整的功能支持 +- **长远规划** - 新架构将为未来更多创新功能奠定基础 + +**🔔 如何获取更新通知?** + +- ⭐ Star本项目,GitHub会自动推送Release通知 +- 📱 加入技术交流群,第一时间获取更新消息 +- 🔗 关注项目README和官方公告 + +期待7月份为大家带来更强大的PromptX! 🎉 + +
+ --- ## 🎨 **女娲创造工坊 - 让每个人都成为AI角色设计师** diff --git a/assets/qa/install/install-failed.png b/assets/qa/install/install-failed.png new file mode 100644 index 0000000..ca377e3 Binary files /dev/null and b/assets/qa/install/install-failed.png differ diff --git a/assets/qa/install/install-success.png b/assets/qa/install/install-success.png new file mode 100644 index 0000000..2df644d Binary files /dev/null and b/assets/qa/install/install-success.png differ