Agent Skills › datavane/tis › gen-plugin-doc

gen-plugin-doc

GitHub

根据TIS插件Java源码及元数据，自动生成面向非技术人员的简介文档。分析类逻辑与注解，提取核心功能、场景及工作机制，生成结构清晰的Markdown说明文件。

.claude/skills/gen-plugin-doc/SKILL.md datavane/tis

Trigger Scenarios

需要为TIS插件编写用户介绍文档指定插件类路径并要求生成简介

Install

npx skills add datavane/tis --skill gen-plugin-doc -g -y

More Options

Non-standard path

npx skills add https://github.com/datavane/tis/tree/master/.claude/skills/gen-plugin-doc -g -y

Use without installing

npx skills use datavane/tis@gen-plugin-doc

指定 Agent (Claude Code)

npx skills add datavane/tis --skill gen-plugin-doc -a claude-code -g -y

安装 repo 全部 skill

npx skills add datavane/tis --all -g -y

预览 repo 内 skill

npx skills add datavane/tis --list

SKILL.md

Frontmatter

{
    "name": "gen-plugin-doc",
    "license": "MIT",
    "metadata": {
        "author": "mozhenghua",
        "version": "1.0"
    },
    "description": "为TIS插件生成简介文档。为指定的TIS插件类生成markdown格式的使用说明文档，帮助用户快速了解插件的核心作用和工作机制。"
}

TIS插件简介文档生成器

此命令为指定的TIS插件类生成一份简洁的使用说明文档。

使用方法

/gen-plugin-doc <插件类的绝对路径>

示例：

/gen-plugin-doc /Users/mozhenghua/j2ee_solution/project/tis-solr/tis-plugin/src/main/java/com/qlangtech/tis/plugin/proxy/HttpRequestProxy.java

任务说明

为指定的TIS插件类生成markdown格式的简介文档。该文档帮助TIS用户快速了解插件的核心作用和工作机制。

输入参数

插件类绝对路径：插件Java源文件的完整路径（从项目根目录到.java文件）
- 示例：/Users/mozhenghua/j2ee_solution/project/tis-solr/tis-plugin/src/main/java/com/qlangtech/tis/plugin/proxy/HttpRequestProxy.java

文档素材

使用以下素材信息生成有针对性的说明文档：

插件类文件：
- 读取指定的Java文件
- 识别带有 @FormField 标注的字段，了解插件向用户暴露的属性
- 分析类中的业务执行逻辑
插件元数据文件（JSON）：
- 路径规则：将 src/main/java/com/foo/bar/PluginClass.java 转换为 src/main/resources/com/foo/bar/PluginClass.json
- 包含插件字段的markdown格式元数据说明（默认值、placeholder、label、help使用说明）
插件描述文件（Markdown，可选）：
- 路径规则：将 src/main/java/com/foo/bar/PluginClass.java 转换为 src/main/resources/com/foo/bar/PluginClass.md
- 包含插件字段的markdown格式说明（每个字段以 ## fieldName 起头）
- 此文件可能不存在
插件描述类：
- 查找插件类中带有 @TISExtension 标注的内部类（如：DefaultDescriptor）
- 以 validate 或 verify 为前缀的方法包含插件的校验约束规则