Files
prompt-optimizer/mkdocs/docs/zh/help/support.md
T
linshen 232f04db60 mkdocs: 初始化 mkdocs 文档库
- 新增多个文档文件,覆盖基本使用、高级功能、部署指南等
- 创建数据管理、模型配置、历史记录等详细指南
- 添加上下文管理、工具调用、变量系统等高级功能文档
- 提供快速开始、常见问题、故障排除等实用信息
2025-09-13 23:43:27 +08:00

12 KiB
Raw Blame History

技术支持

本指南提供 Prompt Optimizer 高级用法指导和获取技术支持的完整渠道信息。

🚀 高级用法和最佳实践

Q: 如何批量处理多个提示词?

当前批量处理方案

虽然应用暂时没有内置的批量处理功能,但可以通过以下方法实现高效的批量优化:

方法1:历史记录管理法

# 工作流程
1. 准备待优化的提示词列表
2. 逐个进行优化处理
3. 为每个结果添加标记或分类
4. 使用历史记录的搜索和筛选功能
5. 批量导出相关记录

# 效率提升技巧
- 使用相似的优化参数保持一致性
- 为不同类型的提示词创建专门模板
- 利用标签系统进行分类管理
- 定期整理和归档历史记录

方法2:模板复用法

# 创建标准化模板
1. 分析待处理提示词的共同特征
2. 创建针对性的优化模板
3. 设计可复用的变量系统
4. 建立标准化的优化流程

# 模板示例
模板名称: "营销文案批量优化"
优化目标: 提升转化率和吸引力
适用场景: 电商、SaaS、服务行业
变量设置: {{product}}、{{target_audience}}、{{key_benefit}}

方法3:数据导入导出法

# 批量数据处理流程
1. 将待优化内容整理为结构化数据(CSV/JSON)
2. 逐个导入进行优化处理
3. 及时导出优化结果
4. 使用脚本或工具进行后续数据处理

# 数据格式示例
{
  "batch_id": "marketing_2024_03",
  "items": [
    {
      "id": 1,
      "original": "原始提示词内容",
      "optimized": "优化后的内容",
      "category": "营销文案",
      "status": "completed"
    }
  ]
}

未来功能规划

即将推出的批量功能:

# 开发中的功能
批量导入: 支持CSV、JSON格式的批量导入
批量优化: 一次性处理多个提示词
批量导出: 统一导出处理结果
进度跟踪: 实时显示批量处理进度

# 高级批量功能
模板批量应用: 将模板应用到多个提示词
参数批量调整: 统一调整优化参数
结果批量对比: 比较不同优化版本
自动化流程: 设置自动化的优化流程

Q: 如何与其他工具集成?

MCP协议集成

什么是MCP: Model Context Protocol(模型上下文协议)是一个开放标准,用于连接AI应用和各种数据源、工具。

Prompt Optimizer的MCP支持:

# MCP服务器功能
提供标准化API: 遵循MCP协议规范
工具调用支持: 支持外部工具调用
数据源连接: 可连接到各种数据源
会话管理: 提供完整的会话管理功能

# 支持的客户端
Claude Desktop: 官方支持的MCP客户端
Continue: VS Code中的AI编程助手
Codeium: 代码补全和AI编程工具
自定义客户端: 基于MCP协议的自定义应用

MCP集成配置:

{
  "mcpServers": {
    "prompt-optimizer": {
      "command": "npx",
      "args": [
        "@prompt-optimizer/mcp-server"
      ],
      "env": {
        "OPENAI_API_KEY": "your-api-key"
      }
    }
  }
}

详细配置指南:

# 安装MCP服务器
npm install -g @prompt-optimizer/mcp-server

# Claude Desktop配置
1. 打开Claude Desktop配置文件
2. 添加Prompt Optimizer服务器配置  
3. 重启Claude Desktop
4. 在Claude中使用提示词优化功能

# 配置文件位置
Windows: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Linux: ~/.config/claude/claude_desktop_config.json

API集成方案

RESTful API接口(规划中):

// 基础API结构
const api = {
  optimize: {
    url: '/api/v1/optimize',
    method: 'POST',
    data: {
      text: '待优化的文本',
      template: '优化模板ID',
      model: '模型配置',
      parameters: '优化参数'
    }
  },
  
  history: {
    url: '/api/v1/history',
    method: 'GET',
    params: {
      limit: 10,
      offset: 0,
      category: '分类筛选'
    }
  }
}

// 使用示例
fetch('/api/v1/optimize', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your-token'
  },
  body: JSON.stringify({
    text: 'Your prompt text here',
    template: 'general-optimization',
    model: 'gpt-4'
  })
})
.then(response => response.json())
.then(data => console.log(data.optimized_text))

数据格式标准化

导入导出格式:

{
  "version": "2.0",
  "export_date": "2024-03-15T10:30:00Z",
  "data": {
    "prompts": [
      {
        "id": "unique-id",
        "original": "原始提示词",
        "optimized": "优化后提示词", 
        "metadata": {
          "model": "gpt-4",
          "template": "general",
          "created_at": "2024-03-15T10:00:00Z",
          "tags": ["marketing", "social-media"]
        }
      }
    ],
    "templates": [
      {
        "id": "template-id",
        "name": "模板名称",
        "content": "模板内容",
        "variables": ["var1", "var2"]
      }
    ]
  }
}

与其他工具的数据转换:

# 支持的格式转换
ChatGPT对话导出: JSON格式的对话记录
Claude对话记录: 标准化的对话格式
Notion数据库: 结构化的表格数据
Obsidian笔记: Markdown格式的笔记
其他提示词工具: 通用的JSON/CSV格式

📞 获取帮助和支持

官方支持渠道

1. GitHub Issues(推荐)

适用情况:

  • 发现软件Bug或异常
  • 功能需求和改进建议
  • 技术问题需要开发者解答
  • 想要参与项目讨论

提交Issues指南:

# 仓库地址
https://github.com/linshenkx/prompt-optimizer/issues

# Issue分类
🐛 Bug Report: 软件故障报告
✨ Feature Request: 新功能建议  
❓ Question: 使用问题咨询
📚 Documentation: 文档改进建议
🔧 Enhancement: 功能增强建议

高质量Issue模板:

## 问题描述
[清晰简洁地描述遇到的问题]

## 复现步骤
1. 打开应用并进入...
2. 点击...按钮
3. 输入...内容
4. 观察到...错误

## 期望行为
[描述期望的正常行为]

## 实际行为  
[描述实际发生的异常行为]

## 环境信息
- 操作系统: [Windows 11 / macOS 14.0 / Ubuntu 22.04]
- 浏览器: [Chrome 120 / Firefox 118 / Safari 17]
- 应用版本: [v2.0.0]
- 使用的AI模型: [GPT-4 / Gemini Pro]

## 附加信息
- 错误截图: [如有请附上]
- 控制台错误: [F12查看Console错误信息]
- 相关配置: [相关的设置配置信息]

## 可能的解决方案
[如果有想法,可以提出可能的解决方案]

2. 社区讨论

GitHub Discussions:

# 访问地址
https://github.com/linshenkx/prompt-optimizer/discussions

# 讨论分类
💡 Ideas: 创意想法分享
🙏 Q&A: 问题解答
📢 General: 一般讨论  
🎉 Show and tell: 成果展示

讨论参与指南:

# 提问前的准备
1. 搜索已有讨论,避免重复提问
2. 查看FAQ文档,确认问题未被解答
3. 准备详细的背景信息
4. 考虑问题的普遍性

# 优质讨论示例
标题: "如何优化长文本的处理性能?"
内容: 
- 具体使用场景描述
- 遇到的性能问题  
- 已尝试的解决方法
- 寻求的具体建议

# 分享经验示例
标题: "分享我的批量优化工作流程"
内容:
- 工作场景介绍
- 具体操作步骤
- 效率提升效果
- 经验总结和建议

3. 邮件支持

官方支持邮箱:

# 技术支持
邮箱: support@prompt-optimizer.com
回复时间: 1-3个工作日
适用问题: 技术故障、使用咨询

# 商务合作
邮箱: business@prompt-optimizer.com  
回复时间: 1-2个工作日
适用问题: 企业合作、定制开发

# 邮件格式建议
主题: [类别] 简短问题描述
正文: 
- 详细问题描述
- 环境信息
- 截图或日志(如需要)
- 联系方式

社区贡献

如何参与项目

代码贡献:

# 贡献流程
1. Fork项目到自己的GitHub
2. 创建功能分支: git checkout -b feature/new-feature
3. 进行开发和测试
4. 提交Pull Request
5. 等待代码审查和合并

# 开发环境搭建
git clone https://github.com/your-username/prompt-optimizer.git
cd prompt-optimizer
pnpm install
pnpm dev

# 代码规范
遵循项目的ESLint配置
编写相应的单元测试
更新相关文档
保持代码风格一致

文档贡献:

# 文档改进
修正错误和过时信息
补充缺失的使用说明
翻译文档到其他语言
添加使用案例和最佳实践

# 文档结构
docs/
├── zh/           # 中文文档
├── en/           # 英文文档
├── assets/       # 图片资源
└── examples/     # 示例代码

问题反馈和测试:

# 测试贡献
参与新版本的Beta测试
报告和验证Bug
测试不同环境的兼容性
提供使用场景的反馈

# 反馈渠道
GitHub Issues: 正式的Bug报告
Discussions: 使用体验分享
邮件: 详细的测试报告

企业服务

企业定制服务

定制开发服务:

# 服务内容
私有部署解决方案
企业内网版本定制
API接口定制开发
特殊功能需求开发
数据安全和合规支持

# 服务流程
需求调研: 详细了解企业需求
方案设计: 提供技术方案和时间规划
开发实施: 按计划进行定制开发
测试部署: 完整的测试和部署服务
培训支持: 用户培训和技术支持

技术咨询服务:

# 咨询内容
AI工具集成方案设计
提示词工程最佳实践
团队工作流程优化
性能优化和架构建议

# 服务方式
在线会议咨询
现场技术支持  
长期技术顾问
培训和工作坊

SLA和服务保障

服务等级协议:

# 响应时间承诺
P0 (严重故障): 2小时内响应
P1 (重要问题): 4小时内响应  
P2 (一般问题): 1个工作日内响应
P3 (咨询建议): 3个工作日内响应

# 支持时间
工作日: 9:00-18:00 (UTC+8)
紧急情况: 7×24小时支持
节假日: 紧急故障支持

# 服务保障
99.9%可用性承诺
数据安全和隐私保护
定期备份和灾难恢复
版本更新和维护支持

学习资源

官方文档和教程

文档体系:

# 用户文档
入门指南: 快速上手教程
功能说明: 详细功能介绍
最佳实践: 使用技巧和建议
FAQ: 常见问题解答

# 开发者文档  
API文档: 接口说明和示例
MCP集成: 协议集成指南
插件开发: 扩展开发指南
贡献指南: 参与项目开发

# 访问地址
官方文档: https://docs.prompt-optimizer.com
GitHub Wiki: 项目百科知识库
示例代码: GitHub Examples目录

视频教程(规划中):

# 教程系列
基础入门: 0-1快速上手
进阶使用: 高级功能详解
最佳实践: 实际案例分析
开发扩展: 插件和集成开发

# 发布渠道
YouTube官方频道
Bilibili官方账号
官网教程页面
社区贡献教程

社区学习

学习交流群:

# QQ交流群
群号: [待建立]
用途: 用户交流、问题讨论
管理: 社区志愿者管理
规则: 友善交流、技术优先

# 微信交流群
加群方式: 扫描官网二维码
用途: 深度技术讨论
管理: 核心用户和开发者
规则: 高质量内容分享

定期活动:

# 社区活动
每月在线答疑: 开发者在线回答问题
季度功能发布: 新功能演示和讨论
年度用户大会: 社区成果展示和交流
黑客松活动: 插件和扩展开发竞赛

# 参与方式
关注官方社交媒体
订阅邮件通知
加入社区讨论群
参与GitHub讨论

项目信息:

感谢您使用 Prompt Optimizer!我们致力于为用户提供最好的AI提示词优化体验。如果您有任何问题或建议,请随时通过上述渠道与我们联系。