java-docs

Analyze Java Spring Boot projects and generate API, deployment, and operations documentation.

Updated Dec 23, 2025
One-click install
npx skills add https://github.com/BNTang/Sa-Token-Demo --skill java-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: java-docs
Source: https://github.com/BNTang/Sa-Token-Demo/tree/main/.claude/skills/java-docs
Command: npx skills add https://github.com/BNTang/Sa-Token-Demo --skill java-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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

Frequently Asked Questions about java-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate API documentation for a Spring Boot project?

Use the skill to analyze Maven or Gradle Spring Boot projects, extracting controller mappings and application.yml configurations to auto-generate API design documents, deployment manuals, and operations guides in the docs/ directory.

Can I extract enum data dictionaries and DTO structures from Java code?

Yes, you can extract enum data dictionaries and DTO/VO structures from Java code. The skill automatically analyzes these components and embeds the unified return objects and pagination structures directly into the generated documentation.

Does the documentation generation work with Knife4j and Swagger configurations?

The documentation generation works with Knife4j and Swagger configurations by extracting settings and supporting online document analysis with offline export capabilities, including access address prompts in the final output.

How do I create deployment and operations manuals for a Maven Spring Boot application?

Create deployment and operations manuals for a Maven Spring Boot application by running the skill to parse project configurations and generate docs/deployment.md and docs/operations.md, along with optional start/stop scripts in the scripts/ directory.

What is the best way to export offline API docs from a Spring Boot application?

The best way to export offline API docs from a Spring Boot application is using the skill to analyze Knife4j settings and project structures, generating a static markdown API design document that covers interface specifications and method lists.