EMP Skill Platform - 系统文档

📚 文档导航

🚀 快速开始

文档	说明
项目总览	项目介绍、架构、快速开始
CLI 使用指南	CLI 工具的完整使用指南
Web 平台指南	Web 平台功能和使用说明
部署运维	部署、监控和运维指南

🛠️ 技术文档

文档	说明
系统架构	整体架构设计和技术选型
API 参考	完整的 API 接口文档
贡献指南	贡献规范和流程

📋 文档结构

docs/
├── README.md              # 📖 文档索引
├── ARCHITECTURE.md        # 🏗️ 系统架构
├── CLI_GUIDE.md          # 🔧 CLI 使用指南
├── WEB_PLATFORM.md       # 🌐 Web 平台指南
├── DEPLOYMENT.md         # 🚀 部署运维
├── API_REFERENCE.md      # 📡 API 接口文档
└── CONTRIBUTION.md       # 🤝 贡献指南

🎯 阅读指南

新手入门

1. 📖 项目总览 - 了解项目概况
2. 🔧 CLI 使用指南 - 学习 CLI 工具
3. 🌐 Web 平台指南 - 探索 Web 功能

开发者指南

1. 🏗️ 系统架构 - 理解技术架构
2. 📡 API 参考 - 查看接口文档
3. 🚀 部署运维 - 学习部署流程

贡献者指南

1. 🤝 贡献指南 - 如何参与贡献
2. 🏗️ 系统架构 - 了解代码结构

🔍 搜索和查找

按主题查找

CLI 相关

• 安装和设置 → CLI_GUIDE.md
• 命令使用 → CLI_GUIDE.md
• 故障排除 → CLI_GUIDE.md

Web 平台相关

• 功能介绍 → WEB_PLATFORM.md
• 用户界面 → WEB_PLATFORM.md
• 性能优化 → WEB_PLATFORM.md

开发相关

• 架构设计 → ARCHITECTURE.md
• API 接口 → API_REFERENCE.md
• 部署流程 → DEPLOYMENT.md

按用户角色查找

👨‍💻 开发者

• 系统架构
• API 参考
• 贡献指南

👤 用户

• CLI 使用指南
• Web 平台指南

🚀 运维人员

• 部署运维
• 系统架构

📝 文档维护

更新文档

# 编辑文档
vim docs/README.md

# 提交更改
git add docs/README.md
git commit -m "docs: update documentation"

文档规范

• 使用 Markdown 格式
• 保持中英文对照
• 代码示例完整可运行
• 链接引用准确无误

🤝 反馈和建议

文档问题

• GitHub Issues: https://github.com/emp/skill/issues
• 标签: documentation

改进建议

• GitHub Discussions: https://github.com/emp/skill/discussions
• 分类: Documentation

📊 文档统计

• 总文档数: 7 个
• 主要语言: 中文 + 英文
• 更新频率: 随版本发布更新
• 维护者: EMP Team

🔗 相关链接

• 项目主页: https://emp-skill.com
• GitHub 仓库: https://github.com/emp/skill
• Discord 社区: https://discord.gg/emp-skill

---

文档 = 连接用户和开发者的桥梁 🌉

最后更新: 2025-01-23