logo
0
0
WeChat Login
linshen<32978552+linshenkx@users.noreply.github.com>
refactor(template): 优化模板管理与服务注入,增强错误处理并添加故障排除清单

项目文档索引

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