Files
prompt-optimizer/docs/README.md
linshen acf592ab2c refactor(template): 优化模板管理与服务注入,增强错误处理并添加故障排除清单
- 添加模板管理故障排除清单,以帮助用户解决模板管理中遇到的常见问题。
- 统一服务注入逻辑,移除不必要的props定义,增强错误处理机制。
- 优化模板管理,统一服务注入与存储键管理。
- 更新 `TemplateSelect.vue`,移除 `services` prop,改用 `inject` 注入服务。
- 整合 `useTemplateManager`,统一模板选择保存逻辑及存储键管理。
- 新增 `storage-keys.ts`,集中管理存储键常量,避免重复定义,便于维护与遍历。
- 更新相关组件以适配新的模板管理方式,确保模板选择状态正确保存和恢复。
- 修正了模板类型错误的问题,确保在管理界面切换分类后添加的模板类型与当前显示的分类一致。
- 修复了模板管理器打开位置错误的问题,确保从不同入口打开模板管理器时,定位到正确的分类。
- 优化了模板保存和导入逻辑,增加了错误处理和提示。
- 确保所有异步模板操作都使用了 `await` 关键字,避免潜在的时序问题。
- 移除了 `usePromptOptimizer` 中 `selectedOptimizationMode` 的默认值,强制传入该参数。
- 优化了 `TemplateSelect` 组件中 `optimizationMode` prop 的处理,设为 `required`。
2025-06-29 10:10:26 +08:00

4.0 KiB
Raw Blame History

项目文档索引

欢迎来到Prompt Optimizer项目文档本文档采用分级分类的组织方式便于不同角色的用户快速找到所需信息。

📚 文档分类

👥 用户文档

面向最终用户的使用指南、部署说明和常见问题

  • 桌面版用户手册
  • Web版使用指南
  • 部署指南Vercel等
  • 常见问题解答

👨‍💻 开发者文档

面向开发者的技术文档、API参考和故障排查

  • 技术开发指南
  • 项目结构说明
  • API文档
  • 架构设计
  • 故障排查清单

📋 项目管理文档

面向项目管理的需求文档、状态跟踪和规划

  • 产品需求文档
  • 项目状态和进度
  • 版本管理策略
  • 功能规划

📦 开发过程归档

按功能点归档的开发记录,用于跟踪和排错

  • 101-singleton-refactor - 单例模式重构
  • 102-web-architecture-refactor - Web架构重构
  • 103-desktop-architecture - 桌面端架构 🔄
  • 104-test-panel-refactor - 测试面板重构 📋
  • 105-output-display-v2 - 输出显示v2 📋
  • 106-template-management - 模板管理功能 🔄

🛠️ 开发工作区

当前开发阶段的临时文档和开发笔记

  • 开发笔记和临时记录
  • 待办事项
  • 实验性设计

🚀 快速导航

我是用户

我是开发者

我是项目管理者

📖 重要文档

核心文档

专项文档

📋 使用指南

新成员入职

  1. 阅读项目总体介绍了解项目概况
  2. 查看项目结构了解代码组织
  3. 参考技术开发指南了解开发规范
  4. 根据角色查看对应的文档分类

日常开发

  1. 遵循技术开发指南中的开发规范
  2. 遇到问题查看故障排查
  3. 了解历史背景查看开发过程归档

项目管理

  1. 通过项目状态了解当前进度
  2. 查看产品需求文档了解功能规划

🔄 文档维护

维护原则

  1. 分类明确:按目标受众和用途分类存放
  2. 及时更新:代码变更时同步更新相关文档
  3. 定期整理:定期清理过期内容,整理工作区文档
  4. 交叉引用:在相关文档间建立引用关系

文档规范

  • 使用Markdown格式
  • 统一的标题层级结构
  • 代码示例使用语法高亮
  • 文档末尾标注更新时间

归档流程

  • 新功能开发在archives/中创建新的功能点目录从107开始编号
  • 重要经验及时从workspace/转移到archives/对应功能点
  • 通用指南从临时记录整理为正式的developer/文档

文档重构完成时间2025-07-01 下一次整理计划:根据开发进度定期更新