mirror of https://github.com/linshenkx/prompt-optimizer.git synced 2026-05-07 05:56:49 +08:00

Files

linshen 8b55f0e574 feat: 修复Monorepo构建与依赖解析问题，优化开发命令，更新依赖，完善文档，简化项目结构，统一异步调用，优化错误处理

本次提交主要完成了以下变更：

- 在`package.json`中新增`dev:desktop:parallel:fixed`命令，解决并行进程导致的样式丢失问题。
- 更新`experience.md`文档，记录Monorepo中构建与依赖管理的最佳实践和遇到的问题。
- 在`scratchpad.md`中详细记录了修复过程和解决方案，确保后续开发者能够参考。
- 更新pnpm锁定文件，添加dotenv和@prompt-optimizer/core依赖。
- 更新Electron版本至^37.1.0，修复桌面端IndexedDB问题。
- 简化项目结构，删除 `pnpm-lock.yaml` 文件和冗余文档。
- 将多个同步方法改为异步方法，确保模板管理器的操作能够正确处理异步逻辑。
- 优化模板获取和列表加载的逻辑，统一使用 `await` 关键字，避免潜在的时序问题。

这些更新旨在提升项目的稳定性和开发效率，确保最佳实践得到贯彻。

2025-06-29 15:00:27 +08:00

README.md

项目文档索引

欢迎来到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 - 模板管理功能 🔄

🛠️ 开发工作区

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

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

🚀 快速导航

我是用户

想了解如何使用 → 用户文档
需要部署应用 → 部署指南
遇到使用问题 → 故障排查

我是开发者

想参与开发 → 开发者文档
需要了解架构 → 技术开发指南
遇到开发问题 → 故障排查
想了解历史 → 开发过程归档

我是项目管理者

了解项目状态 → 项目管理文档
查看功能规划 → 产品需求文档
跟踪开发进度 → 项目状态

📖 重要文档

核心文档

项目总体介绍 - 项目概述和快速开始
技术开发指南 - 完整的技术栈和开发规范
项目结构 - 文件和目录组织说明
产品需求文档 - 产品功能需求和规格

专项文档

LLM参数配置指南 - LLM参数配置详细说明
AI开发流程规范 - AI辅助开发的标准化流程

📋 使用指南

新成员入职

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

日常开发

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

项目管理

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

🔄 文档维护

维护原则

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

文档规范

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

归档流程

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

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

README.md Unescape Escape