Skip to content

DOCUMENTS_GUIDE.md

Latest commit

 

History

History
82 lines (61 loc) · 2.4 KB

DOCUMENTS_GUIDE.md

File metadata and controls

82 lines (61 loc) · 2.4 KB

📚 Prompt Enhancement v1.1.0 - 文档导航指南

最后更新: 2025-12-24 项目版本: v1.1.0 (生产级)

🎯 快速导航

如果您是第一次接触这个项目，请按以下顺序阅读：

⚡ 5分钟快速上手

  1. README.md - 项目概览和关键特性
  2. QUICK_START.md - 安装和基础使用 (5分钟)
  3. 尝试运行 /pe 命令

📖 完整理解项目

  1. ARCHITECTURE.md - 系统架构和设计原理
  2. API_REFERENCE.md - 完整API文档
  3. TESTING_GUIDE.md - 测试框架和覆盖率

🔧 开发和部署

🆘 遇到问题？

  • 查看 QUICK_START.md 的 "常见问题" 部分
  • 检查日志文件: ~/.pe/logs/pe.log

📁 文档结构

根目录/
├── README.md                    ⭐ 主入口
├── QUICK_START.md              ⭐ 5分钟上手
├── ARCHITECTURE.md             📐 架构文档
├── API_REFERENCE.md            📖 API参考
├── TESTING_GUIDE.md            ✅ 测试指南
├── INSTALL.md                  🔧 安装说明
├── INTEGRATION_GUIDE.md         🔗 集成指南
├── DOCUMENTS_GUIDE.md           👈 本文件
├── docs/
│   ├── sprint-status.yaml       📊 项目进度
│   └── stories/                 📋 用户故事详情
└── ARCHIVE/                     🗂️  过期文档归档

📊 项目完成度

指标 状态 备注
功能完整 ✅ 6个Epic, 28个用户故事完成
测试覆盖 ✅ 874个测试, 100%通过, 81%覆盖率
生产就绪 ✅ 零缺陷, A级质量

🚀 立即开始

# 1. 克隆并进入项目
git clone <repository-url>
cd Prompt-Enhancement

# 2. 阅读快速开始指南
cat QUICK_START.md

# 3. 安装和配置
pip install -r requirements.txt
cp .env.example .env
# 编辑 .env 添加你的 API 密钥

# 4. 运行第一个命令
python -m prompt_enhancement "请帮我优化这个代码"

需要帮助？ 从 QUICK_START.md 开始！