📚 项目文档导航
本文档提供项目所有文档的分类索引，帮助快速查找所需信息。
📑 文档分类
🏗️ 架构设计
| 文档 | 说明 | 路径 |
|---|---|---|
| 架构文档 | 应用架构、工程化配置、目录结构 | architecture/ARCHITECTURE.md |
| 组件索引 | 22个组件目录的分类索引 | architecture/COMPONENTS.md |
💻 开发配置
| 文档 | 说明 | 路径 |
|---|---|---|
| ESLint + Prettier | 代码规范与自动格式化配置 | development/ESLINT_PRETTIER.md |
| Husky + lint-staged | Git Hooks 自动化检查配置 | development/HUSKY_LINT_STAGED.md |
| 开发工作流 | 团队开发流程与规范 | development/WORKFLOW.md |
🧪 测试文档
| 文档 | 说明 | 路径 |
|---|---|---|
| Playwright 指南 | E2E 测试框架完整指南 | testing/PLAYWRIGHT.md |
| E2E 认证指南 | 测试登录认证流程 | testing/E2E_AUTH_GUIDE.md |
| E2E 代理配置 | Vite 反向代理配置说明 | testing/E2E_PROXY_SETUP.md |
| E2E 测试服务器 | 测试环境配置与服务器信息 | testing/E2E_TEST_SERVER.md |
🛠️ 工具指南
| 文档 | 说明 | 路径 |
|---|---|---|
| Claude Skills | Claude Code 技能完全指南 | tools/SKILLS_GUIDE.md |
| API Generator Guide | OpenAPI 文档自动生成 API 代码完全指南 | tools/API_GENERATOR_GUIDE.md |
📝 变更记录
| 文档 | 说明 | 路径 |
|---|---|---|
| 更新日志 | 功能更新历史（按时间倒序） | CHANGELOG.md |
📋 任务管理
| 目录 | 说明 | 路径 |
|---|---|---|
| 已完成任务 | 已完成的功能记录 | tasks/done/ |
| 开发计划 | 进行中和计划中的功能 | tasks/plan/ |
| 待办事项 | 待办功能列表 | tasks/todo/ |
🚀 快速查找
按场景查找
我要...
- 🆕 新项目上手 → 架构文档
- 🔧 配置开发环境 → ESLint + Prettier
- 🧪 编写 E2E 测试 → Playwright 指南
- 🔐 测试登录功能 → E2E 认证指南
- 📝 了解更新内容 → 更新日志
- 🛠️ 使用 Claude Skills → Claude Skills 指南
- ⚡ 生成 API 代码 → API Generator 指南
按角色查找
前端开发者
- 架构文档 - 了解项目结构
- 组件索引 - 查找可复用组件
- ESLint + Prettier - 配置代码规范
- 开发工作流 - 遵循团队流程
测试工程师
- Playwright 指南 - E2E 测试框架
- E2E 认证指南 - 测试认证流程
- E2E 代理配置 - 配置测试环境
- E2E 测试服务器 - 测试服务器信息
新成员
📖 文档编写规范
新增文档时，请遵循以下规则：
1. 文件命名
- ✅ 使用大写字母和下划线：
ARCHITECTURE.md - ✅ 使用英文命名，文件名清晰描述内容
- ❌ 避免中文文件名（
工作流.md→WORKFLOW.md） - ❌ 避免空格和特殊字符
2. 文档分类
根据文档内容，放入对应目录：
docs/
├── architecture/ # 架构设计类文档
├── development/ # 开发配置类文档
├── testing/ # 测试相关文档
├── tools/ # 工具使用指南
└── tasks/ # 任务管理（done/plan/todo）
3. 更新索引
新增文档后，必须更新本 README.md：
- 在对应分类下添加文档链接
- 更新"快速查找"部分（如果适用）
- 遵循现有格式和风格
4. 文档结构
每个文档应包含：
# 文档标题
> 简短描述（1-2句话）
## 目录
- [背景](#背景)
- [安装](#安装)
- [使用](#使用)
- [API](#api)
- [常见问题](#常见问题)
## 背景
说明文档的背景和目标
## 安装
step-by-step 安装指南
## 使用
详细使用说明
## 常见问题
Q&A 格式
🔍 搜索技巧
在文档中搜索
# 在所有文档中搜索关键词
cd docs
grep -r "关键词" .
# 只搜索 .md 文件
grep -r "关键词" . --include="*.md"
# 搜索特定目录
grep -r "关键词" ./testing/
VS Code 搜索
-
Ctrl/Cmd + Shift + F- 全局搜索 - 在搜索框中输入关键词
- 限制搜索范围：
docs/**/*.md
📊 文档统计
| 分类 | 文档数量 | 最后更新 |
|---|---|---|
| 架构设计 | 2 | - |
| 开发配置 | 3 | - |
| 测试文档 | 4 | - |
| 工具指南 | 2 | - |
| 任务管理 | 3 | - |
| 总计 | 14 | - |
🤝 贡献指南
发现文档问题？欢迎改进：
- 修正错误：直接修改文档并提交 PR
- 补充内容：在对应分类下新增文档
-
优化索引：改进本
README.md的导航结构
注意事项：
- 保持客观、准确
- 提供示例和代码
- 更新日期和版本信息
- 遵循现有文档风格
🔗 相关资源
- 项目主 README
- CLAUDE.md - 项目架构与开发指南
- 代码规范 - 全局编码规范
- Vue 最佳实践 - Vue 3 开发指南
最后更新: 2026-01-29 维护者: 开发团队