# ptest 项目文档

## 📋 文档概述

本文档目录提供 ptest 测试框架的完整文档，包括用户指南、架构设计、使用指南和 API 参考。

## 🗂️ 文档结构

### 👥 用户指南 (`user-guide/`)
面向最终用户的使用文档：
- [快速开始指南](user-guide/README.md)
- [基础使用教程](user-guide/basic-usage.md)
- [高级功能指南](user-guide/advanced-features.md)
- [常见问题解答](user-guide/faq.md)

### 🏗️ 架构文档 (`architecture/`)
面向架构师和高级开发者的设计文档：
- [系统架构总览](architecture/system-overview.md)
- [环境隔离架构](architecture/environment-isolation.md)
- [数据库架构](architecture/database-architecture.md)

### 📋 开发文档 (`development/`)
面向框架开发者的技术文档：
- [开发指南](development/development-guide.md)
- [Python API 实现](development/PYTHON_API_IMPLEMENTATION.md)
- [实现计划](development/implementation-plans/)
- [开发进度报告](development/progress-reports/)
- [测试报告](development/test-reports/)

### 📖 使用指南 (`guides/`)
面向开发者的详细使用指南：
- [测试环境管理](guides/environment-management.md)
- [测试用例编写](guides/test-case-writing.md)
- [对象管理指南](guides/object-management.md)
- [报告生成指南](guides/report-generation.md)

### 📔 API 文档 (`api/`)
面向程序员的接口文档：
- [Python API 参考](api/python-api.md)
- [API 使用示例](api/api-examples.md)
- [CLI 命令参考](api/cli-commands.md)

### 🗃️ 归档文档 (`archived/`)
历史文档和过时内容：
- [旧版本文档](archived/old-version-docs.md)
- [已废弃功能](archived/deprecated-features.md)

## 🎯 当前实现状态

### ✅ 已实现功能

#### 环境隔离系统 (ENV-001)
- **阶段一完成** (2026-01-25): 核心隔离基础
  - ✅ 基础文件系统隔离
  - ✅ 隔离管理器框架
  - ✅ 可扩展的插件架构
  - ✅ 完整的测试覆盖

#### Python API
- ✅ 完整的测试框架 API
- ✅ 环境管理接口
- ✅ 对象管理接口
- ✅ 测试用例管理接口

#### 数据库对象管理
- ✅ 服务端/客户端分离架构
- ✅ 多种数据库支持 (MySQL, PostgreSQL, MongoDB, SQLite)
- ✅ 生命周期管理

### 🚧 开发中功能

#### 环境隔离系统 (ENV-001)
- **阶段二计划**: Virtualenv隔离实现
  - 🔄 Python虚拟环境隔离
  - 🔄 包管理和依赖解析
  - 🔄 版本冲突检测

### 📅 计划中功能

#### 高级隔离功能
- **阶段三**: Docker容器隔离
- **阶段四**: Kubernetes集群支持
- **阶段五**: 网络隔离和资源限制

## 🚀 快速开始

1. **查看用户指南**: [快速开始](user-guide/README.md)
2. **了解架构**: [系统架构总览](architecture/system-overview.md)
3. **API参考**: [Python API 文档](api/python-api.md)
4. **开发贡献**: [开发指南](development/development-guide.md)

## 📞 获取帮助

- 📖 [用户指南](user-guide/) - 学习如何使用
- 🏗️ [架构文档](architecture/) - 了解系统设计
- 🛠️ [开发文档](development/) - 参与开发
- 📋 [使用指南](guides/) - 深入使用技巧
- 📔 [API 文档](api/) - 编程接口参考

---

**文档版本**: 2.0  
**最后更新**: 2026-01-25  
**项目版本**: ptest v1.0.1