文档生成器

这个技能用于为 CLI 工具的各个模块生成规范的使用文档。它会分析模块代码结构，了解功能和使用方法，然后在指定目录下生成docs/help.md文件。

使用方式

当用户需要为某个模块生成使用文档时，调用此技能并指定模块路径。

文档规范

生成的使用文档应包含以下内容：

1. 模块标题

• •清晰的模块名称和功能描述

2. 功能概述

• •简要说明模块的主要功能
• •列出支持的核心功能点

3. 使用方法

• •基本的命令格式
• •具体的命令示例
• •参数说明

4. 选项说明

• •每个选项的详细解释
• •选项的类型和默认值
• •简写形式（如果有）

5. 配置说明（如适用）

• •相关配置文件的格式
• •配置字段的说明

6. 注意事项

• •使用时的重要提醒
• •可能的误操作避免

示例输出格式

参考 ./packages/shared/src/business/git/deploy/docs/help.md 的格式：

# 模块名称

功能概述描述

## 功能特性

-   功能 1 描述
-   功能 2 描述
-   功能 3 描述

## 使用方法

```bash
$ mycli 模块名 [options]
```

例如：

$ mycli 模块名 --option1=value1 --option2

选项说明

option1

选项功能描述。

类型：string

默认值：default_value

option2

选项功能描述。

类型：boolean

默认值：false

配置说明（如适用）

配置文件格式和字段说明。

注意事项

• •重要提醒 1
• •重要提醒 2

## 实现步骤

1. 分析用户指定的模块目录结构
2. 读取主要`.ts`代码文件，了解功能实现
3. 提取命令行参数和选项定义
4. 按照规范格式生成help.md文档
5. 将文档保存到模块目录下的docs文件夹中