# doc-auto-gen

**Repository Path**: yzj1/doc-auto-gen

## Basic Information

- **Project Name**: doc-auto-gen
- **Description**: 一款自动生成项目文档、更新日志、架构图表，并在用户同意后自动推送代码到仓库的skills，适用于项目开发维护场景
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-04-07
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: skills技能, skill

## README

# doc-auto-gen

自动生成项目文档、更新日志、架构图表，并在用户同意后自动推送代码到仓库。

## 功能特性

- 📝 **自动生成 README** - 分析项目结构，生成符合项目类型的文档
- 📋 **更新日志管理** - 自动记录代码变更，生成 CHANGELOG
- 📊 **架构图表生成** - 业务流程图、框架架构图、数据交互逻辑图
- 🚀 **代码推送** - 用户同意后自动推送到远程仓库

## 安装方法

### 方法一：手动安装（推荐）

1. 克隆仓库到本地：
```bash
git clone https://gitee.com/yzj1/doc-auto-gen.git
```

2. 将 skill 复制到 Trae 的 skills 目录：

**项目级技能**（仅当前项目可用）：
```bash
cp -r doc-auto-gen /你的项目/.trae/skills/
```

**全局技能**（所有项目可用）：
```bash
# macOS/Linux
cp -r doc-auto-gen ~/.trae-cn/skills/

# Windows
copy doc-auto-gen %userprofile%\.trae-cn\skills\
```

### 方法二：使用 skills 命令安装

```bash
npx skills add https://gitee.com/yzj1/doc-auto-gen
```

### 方法三：界面操作

1. 打开 Trae → 设置 → 规则和技能
2. 点击「导入外部技能」
3. 选择下载的 ZIP 文件或直接输入仓库地址

### 方法四：直接让 Trae 安装

在 Trae 对话框中输入：
```
请帮我安装这个 Skills：https://gitee.com/yzj1/doc-auto-gen
```

## 使用方法

### 触发方式

1. **用户请求**：告诉 Trae 需要生成文档或推送代码
2. **代码变更检测**：检测到重大代码变更时，Trae 会提示是否需要执行
3. **任务完成后**：每次任务执行完成，自动检查并更新文档（如已开启自动同步）

### 首次使用配置

首次使用时会提示您：
1. 提供远程仓库地址（如：git@gitee.com:yourname/your-repo.git）
2. 选择是否开启文档自动同步

### 示例对话

```
用户：帮我生成项目的 README
Trae：好的，我来分析项目结构并生成 README...

用户：记录一下今天的更新
Trae：正在获取 git 提交历史，生成更新日志...

用户：把代码推送到仓库
Trae：好的，请确认是否立即推送？（会显示待推送的变更摘要）
```

## 注意事项

- 🔒 所有远程仓库操作需要用户明确同意
- 🔍 推送前会自动检查敏感信息
- 📖 文档会根据项目实际结构生成，不会虚构内容
- 🔄 支持自动同步（可选开启）

## 相关技能

- [coding-standards](https://gitee.com/yzj1/coding-standards) - 项目开发编码规范

## License

MIT