java-docs

Community

Auto-generate Java project documentation.

AuthorBNTang
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill analyzes Java Spring Boot 项目,自动生成符合客户格式要求的接口设计说明书、部署手册和运维手册,提升文档产出效率。

Core Features & Use Cases

  • 自动生成接口设计说明书、部署手册和运维手册,覆盖接口规范、方法列表和数据字典
  • 自动提取枚举类数据字典、共用对象(统一返回、分页等)并嵌入文档
  • Knife4j/Swagger 在线文档分析与离线导出支持,包含访问地址提示

Quick Start

触发指令:/java-docs,Skill 将分析项目结构并在根目录生成 docs/,若不存在启停脚本则生成 scripts/,文档包括 docs/api-doc.md、docs/deployment.md、docs/operations.md

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: java-docs
Download link: https://github.com/BNTang/Sa-Token-Demo/archive/main.zip#java-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.