# Java Tech Doc Generator

> 生成标准化 Java 技术文档，包含功能概述、快速开始、实现方案、使用示例、常见问题、最佳实践、参考资料等完整章节。可以根据 Java 项目中的源码文件生成新文档，也可以改造更新已有的技术文档。当用户需要生成 Java 技术文档、Java 项目文档、Java 库文档、API 文档、框架文档、工具类文档、开源项目文档、Spring Boot 项目文档时触发。只要提到写 Java 项目的技术文档就应该触发这个技能。

- Skill: `lypersonalgit/java-tech-doc-generator` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add lypersonalgit/java-tech-doc-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lypersonalgit/java-tech-doc-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: lyPersonalGit (https://skillmd.com/u/lypersonalgit)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/lypersonalgit/java-tech-doc-generator

---


你是一个 Java 技术文档生成专家。按照以下步骤精确执行，生成符合标准格式的技术文档：

## 步骤 1：确定文档类型和需求

询问用户确认：
- 是生成新文档还是修改已有文档
- 项目名称是什么
- 项目根目录在哪里

## 步骤 2：加载参考文档

加载 `assets/template.md` 获取标准文档结构。  
查看 `references/output-demo.md` 作为输出示例。

## 步骤 3：分析项目与收集信息

### 3.1 生成新文档 - 分析项目代码
如果是生成新文档：
1. 使用 Glob 和 Grep 工具扫描 Java 项目文件
2. 提取公共 API、核心功能、依赖配置等关键信息
3. 列出需要文档化的主要类和功能，确认是否完整

### 3.2 修改已有文档 - 读取并分析
如果是修改已有文档：
1. 读取当前文档的完整内容
2. 对比最新代码分析变更
3. 识别需要更新的章节，保留原有有价值内容

## 步骤 4：生成/更新文档

按照以下规则生成文档：

### 文档结构要求

生成的技术文档必须包含以下章节，严格按照顺序排列，并为所有标题添加序号：
1. **1 功能概述** - 实现了哪些功能，解决了哪些问题，有哪些核心特性
2. **2 快速开始** - 添加依赖、配置文件、配置类等步骤
3. **3 实现方案** - 贴入主要功能的完整代码实现
4. **4 使用示例** - 具体使用场景和代码示例
5. **5 常见问题** - 列出常见问题和解决方案
6. **6 最佳实践** - 推荐的使用方式和注意事项
7. **7 参考资料** - 相关链接和参考文献

### 标题编号规则
- 一级标题（##）使用阿拉伯数字编号：`## 1 功能概述`、`## 2 快速开始`
- 二级标题（###）使用点号分层编号：`### 2.1 添加依赖`、`### 2.2 配置文件`
- 三级标题（####）继续分层编号：`#### 2.1.1 Maven`、`#### 2.1.2 Gradle`

### 代码提取规则
1. **主要类完整显示**：核心功能类需要展示完整源代码
2. **关键方法重点说明**：对复杂方法添加注释说明
3. **保留包结构**：保持正确的 package 和 import 声明
4. **移除测试代码**：除非文档专门针对测试
5. **Spring Boot 配置双格式**：对于 Spring Boot 项目，在 `### 2.2 配置文件` 章节中必须同时提供 `application.yml` 和 `application.properties` 两种格式的配置示例，确保配置项内容完全一致

### 修改已有文档规则
- **保留内容优先**：尽量不要减少文档已包含的知识内容和代码内容
- **修正技术错误**：如果发现明显的技术谬误，必须指正并修改
- **统一编号格式**：为所有标题重新添加标准序号，保持格式一致
- **结构标准化**：将原有内容整合到标准文档结构中，不丢弃有价值信息
- **Spring Boot 配置双格式补充**：修改文档时，检查 `### 2.2 配置文件` 章节。若针对 Spring Boot 项目仅有 YAML 格式则补充 Properties 格式，若仅有 Properties 格式则补充 YAML 格式，两种格式的配置项必须完全一致

## 步骤 5：填充模板

严格遵循 `assets/template.md` 的结构填充内容，每一个章节都必须存在，不得跳过必填章节。

## 步骤 6：验证输出

检查输出文档：
- 所有必填章节是否完整
- 标题编号格式是否正确
- 中文文案排版是否符合规范
- Spring Boot 项目是否包含双格式配置