Files
wwjcloud-nest-v1/wwjcloud-nest-v1/docs/README.md

57 lines
2.4 KiB
Markdown
Raw Normal View History

# WWJCloud NestJS v1 文档中心
> 🎯 **企业级全栈框架文档库** - 基于 NestJS v11超越 Java 的企业能力
## 📖 核心文档
### 🚀 快速开始
- **[V1 框架指南](V1-GUIDE.md)** - 完整开发与运维指南,**建议从这里开始**
### 🏗️ 基础设施层 (Boot)
- **[基础设施配置](V11-INFRA-SETUP.md)** - Boot 层配置与能力说明
- **[Boot 就绪状态](V11-BOOT-READINESS.md)** - 模块生命周期与事件上报
### 🤖 AI 治理层 (AI)
- **[AI 能力路线图](AI-CAPABILITY-ROADMAP.md)** - AI 治理能力详解与规划
- **[AI 开发指南](AI-RECOVERY-DEV.md)** - AI 自愈系统开发指南
- **[AI 安全防护](AI-RECOVERY-SECURITY.md)** - AI 安全机制与防护策略
- **[AI 就绪状态](V11-AI-READINESS.md)** - AI 层模块状态管理
### 🔧 开发规范
- **[一致性指南](CONSISTENCY-GUIDE.md)** - 代码规范与架构对齐
- **[多语言指南](LANG-GUIDE.md)** - i18n 国际化实现指南
## 📚 文档架构
```
docs/
├── README.md # 文档索引(本文件)
├── V1-GUIDE.md # 🚀 一体化总览
├── V11-INFRA-SETUP.md # 🏗️ 基础设施配置
├── V11-BOOT-READINESS.md # 🔄 Boot层生命周期
├── V11-AI-READINESS.md # 🤖 AI层状态管理
├── AI-CAPABILITY-ROADMAP.md # 📊 AI能力规划
├── AI-RECOVERY-DEV.md # 🛠️ AI开发指南
├── AI-RECOVERY-SECURITY.md # 🔒 AI安全防护
├── CONSISTENCY-GUIDE.md # 📋 开发规范
└── LANG-GUIDE.md # 🌐 国际化指南
```
## 🎯 使用建议
### 新用户流程
1. **开始** → 阅读 [V1-GUIDE.md](V1-GUIDE.md) 了解整体架构
2. **配置** → 查看 [V11-INFRA-SETUP.md](V11-INFRA-SETUP.md) 配置基础设施
3. **开发** → 参考 [CONSISTENCY-GUIDE.md](CONSISTENCY-GUIDE.md) 遵循开发规范
### AI 功能开发
1. **了解能力** → [AI-CAPABILITY-ROADMAP.md](AI-CAPABILITY-ROADMAP.md)
2. **开发实现** → [AI-RECOVERY-DEV.md](AI-RECOVERY-DEV.md)
3. **安全考虑** → [AI-RECOVERY-SECURITY.md](AI-RECOVERY-SECURITY.md)
## 📝 维护约定
- **v1 专属**:所有 v1 框架文档仅在本目录维护
- **更新同步**:新增能力需同步更新 `V1-GUIDE.md` 与相关子文档
- **版本控制**:文档变更需通过 Git 版本管理
- **质量保证**:文档需保持与代码实现的一致性