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

6.1 KiB
Raw Blame History

快速上手指南

{% raw %}

{% endraw %}

🚀 欢迎使用提示词优化器

提示词优化器是一个智能工具,帮助您将普通的提示词优化为更专业、更有效的版本。

⚡ 5分钟快速开始(按推荐流程)

1. 基础设置(可选)

  • 在右上角切换主题与语言;刷新后应保持(设置持久化)

2. 配置 AI 模型(必做)

  1. 点击右上角 ⚙️ 模型管理
  2. 选择提供商并输入 API Key(OpenAI/Claude/Gemini/…)
  3. 点击 测试连接(应显示明确成功/失败反馈)
  4. 点击 保存;再次打开时应保持原配置
  5. 主界面模型选择器应能选择刚配置的模型

3. 模板准备(建议)

  1. 点击 📝 功能提示词/模板管理
  2. 浏览/选择模板(支持分类筛选)
  3. 如需自定义:新建→填写名称/描述/内容→保存
  4. 若使用内置模板,可切换模板语言(内置名称/内容随语言切换)

4. 选择优化模式并输入内容(必做)

  1. 在优化区选择模式:
    • 基础模式 → 系统提示词优化(定义“角色/边界/结构”)
    • 基础模式 → 用户提示词优化(优化“任务指令/输出格式”)
  2. 在左侧输入原始提示词
  3. 选择模板与模型

5. 执行优化与查看结果(必做)

  1. 点击 开始优化/Optimize →
  2. 右侧显示优化结果与推理过程;生成 V1 版本
  3. 结果展示功能:
    • 视图切换:Source(Markdown 源码)/Render(渲染视图)
    • 复制:Copy 到剪贴板
    • 全屏:Fullscreen 独立查看结果
    • 对比:Compare 原始 vs 优化(分段差异)
    • 展开编辑:Expand 进入全屏编辑器
  4. 继续优化:输入“改进方向”,生成 V2/V3…,可在版本间切换

🎯 主要功能

📝 提示词优化

  • 智能优化 - AI自动改进您的提示词
  • 多种模板 - 提供不同场景的优化模板
  • 迭代改进 - 可以多次优化直到满意
  • 版本管理 - 保存和切换不同版本

🤖 模型管理

  • 多模型支持 - 支持OpenAI、Claude、Gemini等
  • 连接测试 - 确保API配置正确
  • 智能切换 - 根据需要选择最适合的模型

📚 模板管理

  • 丰富模板 - 内置多种优化模板
  • 自定义模板 - 创建您自己的优化模板
  • 分类管理 - 按类型组织模板

📜 历史记录

  • 自动保存 - 所有优化记录自动保存
  • 快速重用 - 一键重用历史优化结果
  • 搜索功能 - 快速找到需要的历史记录

💾 数据管理

  • 导出备份 - 导出所有数据到本地
  • 导入恢复 - 从备份文件恢复数据
  • 数据清理 - 清除不需要的数据

💡 使用技巧

写好原始提示词

  • 明确目标 - 清楚说明您想要AI做什么
  • 提供背景 - 给出必要的上下文信息
  • 具体描述 - 避免模糊和抽象的表达

选择合适的模板

  • 通用优化 - 适合大多数场景的基础优化
  • 专业领域 - 针对特定领域的专业优化
  • 创意写作 - 适合创意和文学创作的优化

有效使用迭代优化

  • 明确改进方向 - 具体说明需要改进的方面
  • 逐步完善 - 每次迭代专注一个改进点
  • 保存版本 - 保留满意的中间版本

📜 历史与数据(建议)

历史记录

  • 打开“📜 历史记录”,支持浏览、重用、删除与清空(清空含确认)
  • 默认按时间倒序,支持搜索(若开启)

数据管理

  • 导出:将数据导出为 JSON 文件或复制到剪贴板
  • 导入:从文件/剪贴板导入(replace 模式)
  • 导入统计:imported/skipped/predefinedVariablesRemoved(预定义变量覆盖会被剔除)

⚙️ 个性化设置

界面设置

  • 主题切换 - 点击右上角切换日间/夜间模式
  • 语言切换 - 支持中文/英文界面
  • 布局调整 - 界面自适应不同屏幕尺寸

使用偏好

  • 默认模型 - 设置常用的AI模型
  • 常用模板 - 收藏经常使用的模板
  • 历史管理 - 定期清理不需要的历史记录

❓ 常见问题

Q: API密钥在哪里获取?

A:

  • OpenAI: 访问 platform.openai.com 注册并获取API密钥
  • Claude: 访问 console.anthropic.com 获取API密钥
  • Gemini: 访问 ai.google.dev 获取API密钥

Q: 优化失败怎么办?

A:

  1. 检查网络连接是否正常
  2. 确认API密钥是否有效且有足够额度
  3. 尝试使用不同的模型
  4. 简化原始提示词内容

Q: 如何提高优化质量?

A:

  1. 提供更详细的原始提示词
  2. 选择更适合的优化模板
  3. 使用迭代优化功能进行改进
  4. 尝试不同的AI模型

Q: 数据安全吗?

A:

  • 所有数据存储在您的本地浏览器中
  • 不会上传到我们的服务器
  • 您可以随时导出或删除数据
  • API调用直接连接到AI服务商

🔧 故障排除

界面问题

  • 页面无法加载 - 刷新浏览器或清除缓存
  • 按钮无响应 - 检查浏览器是否支持现代Web标准
  • 显示异常 - 尝试调整浏览器缩放比例

功能问题

  • 优化超时 - 检查网络连接,尝试重新优化
  • 结果不显示 - 等待更长时间或刷新页面
  • 历史记录丢失 - 检查浏览器是否允许本地存储

性能问题

  • 运行缓慢 - 关闭其他浏览器标签页释放内存
  • 内存占用高 - 定期清理历史记录和缓存
  • 响应延迟 - 检查网络速度和API服务状态

📞 获取帮助

如果您遇到问题或有改进建议:

  1. 查看文档 - 详细功能说明请参考用户手册
  2. 检查设置 - 确认配置是否正确
  3. 重试操作 - 很多问题可以通过重试解决
  4. 反馈问题 - 记录具体的错误信息和操作步骤

🎉 开始使用

现在您已经了解了基本使用方法,开始体验智能提示词优化的强大功能吧!

记住:好的提示词是与 AI 有效沟通的关键。遇到问题,可通过“历史记录”“数据管理”与“继续优化”快速复用与改进。