Java Wiki 文档生成器

基于 Neo4j 图谱和 LangGraph 工作流的自动化项目文档生成工具。

📋 功能

自动生成以下类型的文档：

• ✅ 系统架构文档 - 模块分析、依赖关系、接口设计等

🚀 快速开始

1. 安装依赖

pip install -r requirements.txt

2. 配置环境

复制环境变量模板并填入配置：

cp env.template .env
nano .env  # 填入 Neo4j 和 OpenAI 配置

3. 测试连接

python test_interfaces.py

4. 生成文档

python main.py

生成的文档位于 output/system_architecture.md

📁 项目结构

wiki_generator/
├── interfaces/              # 数据接口层
│   ├── neo4j_interface.py  # Neo4j 查询接口
│   └── llm_interface.py    # LLM 调用接口
├── graph/                   # LangGraph 工作流
│   └── system_arch_graph.py # 系统架构文档生成工作流
├── prompts/                 # 提示词模板
│   └── system_arch_prompts.py
├── main.py                  # 程序入口
├── test_interfaces.py       # 测试脚本
├── output/                  # 输出目录
└── README.md                # 本文件

📚 详细文档

• 完整使用说明 - 详细功能说明与 API 文档
• 快速开始指南 - 详细的配置与使用步骤

🔧 核心组件

接口层 (interfaces/)

• Neo4jInterface: 封装所有 Cypher 查询，提供模块、依赖、类层次等数据
• LLMInterface: 封装 LLM 调用，提供模板调用、总结、润色等功能

工作流 (graph/)

• SystemArchGraph: 7 个节点的完整工作流
  1. 加载数据
  2. 分析模块
  3. 分析依赖
  4. 分析接口
  5. 分析类层次
  6. 分析核心类
  7. 组装文档

提示词 (prompts/)

所有 LLM 提示词模板的集中管理，便于优化和调整。

🎯 使用示例

独立使用接口

from interfaces import Neo4jInterface, LLMInterface

# Neo4j 查询
with Neo4jInterface() as neo4j:
    blocks = neo4j.get_all_blocks()
    print(f"找到 {len(blocks)} 个模块")

# LLM 调用
llm = LLMInterface()
summary = llm.summarize_text("长文本...", max_length=200)

直接运行工作流

from graph import SystemArchGraph

graph = SystemArchGraph()
result = graph.run(output_path="my_doc.md")

⚙️ 环境变量

必需配置（在 .env 文件中）：

NEO4J_URI=bolt://localhost:7687      # Neo4j 连接地址
NEO4J_USER=neo4j                      # Neo4j 用户名
NEO4J_PASSWORD=password               # Neo4j 密码
OPENAI_API_KEY=sk-xxx                 # OpenAI API Key

可选配置：

LLM_MODEL=gpt-4-turbo-preview         # LLM 模型
LLM_TEMPERATURE=0.3                   # 温度参数 (0.0-1.0)
SOURCE_PATH=/path/to/source           # 源码路径（未来功能）

🔍 Neo4j 图谱要求

节点标签

• Block - 模块（功能聚类）
• File - 文件
• Class - 类
• Interface - 接口
• Enum - 枚举
• Method - 方法
• Field - 字段
• Annotation - 注解
• Record - 记录

关系类型

• block f2c file - Block 与 File 的映射
• file declares class/interface/enum... - 文件声明
• class extends class - 继承
• class implements interface - 实现
• method calls method - 方法调用
• method uses class - 方法使用
• 等等...

节点属性

• name (必需) - 节点名称
• semantic_explanation (推荐) - 语义解释

🚧 扩展开发

添加新的文档类型

1. 在 graph/ 下创建新工作流，如 api_doc_graph.py
2. 在 prompts/ 下创建对应提示词，如 api_doc_prompts.py
3. 在 main.py 中添加调用选项

自定义提示词

编辑 prompts/system_arch_prompts.py，调整各分析模板的内容和格式。

优化查询

编辑 interfaces/neo4j_interface.py，添加或优化 Cypher 查询。

⚠️ 注意事项

• 首次运行建议先用小型项目测试
• LLM API 调用会产生费用，请注意成本
• 确保 Neo4j 图谱数据完整且准确
• 大型项目建议调整查询限制参数

📝 许可

MIT License