Skip to content

Commit 61cbc8f

Browse files
author
谭策
committed
docs(deploy): add AI coding assistant Skill file
- Add SKILL.md: comprehensive project architecture, dev guide, deployment flow - Update README.md: add AI Skill usage instructions
1 parent ce94c7e commit 61cbc8f

2 files changed

Lines changed: 590 additions & 1 deletion

File tree

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
企业级 IT 运维多 Agent 自动化平台 — 基于大语言模型的全开源多Agent智能运维解决方案。
1818

19-
📝[项目愿景与社区共建](项目愿景与社区共建.md) 📝[项目文档网站](https://aiopsdoc-0mwug01t6.maozi.io/)
19+
📝[项目愿景与社区共建](项目愿景与社区共建.md) 📝[项目AI编程Skill](SKILL.md) 📝[项目文档网站](https://aiopsdoc-0mwug01t6.maozi.io/)
2020

2121
[![CI](https://github.com/qinshihu/itops-agent-platform/actions/workflows/ci.yml/badge.svg)](https://github.com/qinshihu/itops-agent-platform/actions/workflows/ci.yml)
2222
[![Release](https://github.com/qinshihu/itops-agent-platform/actions/workflows/release.yml/badge.svg)](https://github.com/qinshihu/itops-agent-platform/actions/workflows/release.yml)
@@ -483,6 +483,52 @@ npm run dev
483483
└── .env.example # 环境变量示例
484484
```
485485

486+
## AI 编程助手 Skill
487+
488+
本项目提供了专用的 AI 编程助手 Skill,帮助开发者通过 AI 工具更高效地理解和贡献代码。
489+
490+
### 什么是 Skill?
491+
492+
Skill 是 AI 编程工具(如 Trae IDE)的扩展配置文件,包含项目的架构说明、开发规范、常用命令等信息。当 AI 工具加载此 Skill 后,能够:
493+
494+
- 快速理解项目结构和代码组织
495+
- 提供符合项目规范的代码建议
496+
- 指导新功能开发的标准流程
497+
- 协助调试和问题排查
498+
499+
### 如何使用?
500+
501+
#### 方式一:Trae IDE(推荐)
502+
503+
1. 使用 Trae IDE 打开本项目
504+
2. Skill 会自动加载,AI 助手将具备项目上下文
505+
3. 直接开始开发,AI 会基于 Skill 提供精准建议
506+
507+
#### 方式二:其他 AI 工具
508+
509+
`SKILL.md` 文件的内容复制到你的 AI 工具配置中:
510+
511+
```bash
512+
# 复制 Skill 内容到剪贴板(Windows PowerShell)
513+
Get-Content SKILL.md | Set-Clipboard
514+
515+
# 或 Linux/Mac
516+
cat SKILL.md | pbcopy # macOS
517+
cat SKILL.md | xclip -selection clipboard # Linux
518+
```
519+
520+
然后将内容粘贴到 AI 工具的系统提示或上下文中。
521+
522+
### Skill 包含内容
523+
524+
- **项目架构**:前后端技术栈、目录结构、核心模块说明
525+
- **开发指南**:环境搭建、常用命令、代码规范
526+
- **新功能开发**:添加 API、页面、数据库迁移的标准流程
527+
- **部署说明**:Docker 部署、CI/CD 配置
528+
- **安全设计**:认证、加密、权限控制等安全机制
529+
530+
详细的 Skill 内容请查看 [SKILL.md](./SKILL.md)
531+
486532
## 文档导航
487533

488534
| 文档 | 说明 |

0 commit comments

Comments
 (0)