mirror of
https://github.com/linshenkx/prompt-optimizer.git
synced 2026-05-06 13:40:14 +08:00
9e4d60fc9c
- Update site/src/main.js with image generation, Prompt Garden, Smart Favorites - Update README.md and README.zh-CN.md with new features - Update docs/project/ to v2.10.0 (project-status, prd, README) - Update docs/README.md timestamp
项目文档索引
欢迎来到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 - 模板管理功能 🔄
🛠️ 开发工作区
当前开发阶段的临时文档和开发笔记
- 开发笔记和临时记录
- 待办事项
- 实验性设计
🚀 快速导航
我是用户
我是开发者
我是项目管理者
📖 重要文档
核心文档
专项文档
📋 使用指南
新成员入职
日常开发
项目管理
🔄 文档维护
维护原则
- 分类明确：按目标受众和用途分类存放
- 及时更新：代码变更时同步更新相关文档
- 定期整理：定期清理过期内容，整理工作区文档
- 交叉引用：在相关文档间建立引用关系
文档规范
- 使用Markdown格式
- 统一的标题层级结构
- 代码示例使用语法高亮
- 文档末尾标注更新时间
归档流程
- 新功能开发：在archives/中创建新的功能点目录（从107开始编号）
- 重要经验：及时从workspace/转移到archives/对应功能点
- 通用指南：从临时记录整理为正式的developer/文档
文档重构完成时间：2025-07-01 最近同步更新：2026-05-03（同步至 v2.10.0） 下一次整理计划：根据开发进度定期更新