Files
prompt-optimizer/docs
linshen 9a4de02438 feat: 完成上下文编辑器重构、组件清理与文档整合
此次提交整合了上下文编辑器的大规模重构、废弃组件的清理以及workspace文档的更新,旨在提升系统性能、代码可维护性和开发体验。

### 主要更新
- **上下文编辑器重构**:
    - 移除 ConversationMessageEditor, ConversationSection 等废弃组件。
    - 清理 ConversationManager 和 ContextEditor 未使用的 props。
    - 实现无障碍功能增强和焦点管理。
    - 创建新的工具 composables 和组件类型。
    - 添加全面的测试覆盖和性能监控。

- **组件与代码清理**:
    - 移除重构前的 `VariableManager.vue` 组件及其导出(497行),由 `VariableManagerModal.vue` 替代。
    - 删除已废弃的 `AdvancedTestPanel.vue` 组件及其导出,已被 `TestAreaPanel` 统一组件完全替代。
    - 清理未使用的 `VariableImportExport.vue` 组件、相关测试文件和类型定义。
    - 遵循 YAGNI 原则,确保移除的组件在任何地方均未被使用。
    - 构建包大小减少约 55KB(3552KB -> 3497KB)。

- **Workspace文档整合**:
    - 归档完整的 Naive UI 迁移项目 (包含8个综合文档)。
    - 补充上下文编辑器重构缺失的spec工作流文档。
    - 建立 `docs/examples/` 目录提供配置模板。
    - 更新归档 `INDEX.md` 多维度快速查找索引。
    - 清理 workspace 目录中15个重复文档。

### 技术改进与优化
- 优化 Git 配置,将 `tsconfig.tsbuildinfo` 从追踪中移除并增强 `.gitignore` 规则覆盖所有 `tsbuildinfo` 文件。
- 添加高级 TypeScript 类型和组件接口,实现工具调用显示和变量导入导出组件。
- 增强变量管理与编辑器集成,并保持 `VariableManager.ts` 服务层(仍在使用)。
- 添加全面的单元测试和e2e测试覆盖,改进开发文档和API指南。
- 所有现有功能完整性验证通过,无构建错误或运行时错误。
2025-09-06 23:45:42 +08:00
..

项目文档索引

欢迎来到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 下一次整理计划:根据开发进度定期更新