DocCraftAI - 智能文档与代码生成框架

项目简介

DocCraftAI 是一个基于 LLM 技术的智能文档与代码生成框架，旨在简化软件开发过程中的文档编写、代码生成和测试用例设计工作。该框架通过标准化的模板和灵活的配置系统，实现了文档和代码的自动化生成，提高开发效率和项目质量。

核心功能

文档生成

• 需求文档（Requirement Document）自动生成
• 设计文档（Design Document）自动生成
• 测试用例文档（Test Cases Document）自动生成

代码生成

• 源代码文件生成
• 测试代码文件生成
• 基于模板的代码定制

项目管理

• 项目结构管理
• 配置文件管理
• 工具调用框架

项目结构

├── docs/              # 项目文档目录
│   ├── design.md      # 设计文档
│   ├── require.md     # 需求文档
│   └── testcases.md   # 测试用例文档
├── src/               # 源代码目录
│   ├── llm/           # LLM客户端模块
│   ├── local_tools/   # 本地工具集
│   └── tools/         # 核心工具实现
│       ├── implment/  # 工具实现
│       └── template/  # 文档和代码模板
├── test/              # 测试代码目录
│   ├── function/      # 功能测试
│   └── unit/          # 单元测试
└── run_test_workflow.py # 测试工作流脚本

技术栈

• 编程语言：Python 3.8+
• 核心框架：自定义 ToolFramework
• LLM 集成：支持通过客户端接口与多种 LLM 服务集成
• 模板引擎：基于文本模板的文档和代码生成
• 测试框架：支持单元测试和功能测试

快速开始

环境要求

• Python 3.8 或更高版本
• 安装必要的依赖（详见 requirements.txt）
• 配置 LLM 服务访问凭证

安装

# 克隆仓库
git clone https://github.com/yourusername/doccraftai.git
cd doccraftai

# 安装依赖
pip install -r requirements.txt

使用示例

from src.tools.main import process_root_request

# 生成需求文档
response = process_root_request(
    root_name="requirement_document",
    user_input="创建一个用户管理系统，包含用户注册、登录和权限管理功能"
)

# 生成设计文档
response = process_root_request(
    root_name="design_document",
    user_input="设计一个用户管理系统的架构"
)

# 生成源代码
response = process_root_request(
    root_name="code_document",
    user_input="创建用户服务类，实现CRUD操作"
)

配置说明

主要配置文件位于 src/tools/config.json，包含：

• 工具定义和参数配置
• 根节点配置和系统提示
• 模板路径配置

测试

运行测试工作流：

python run_test_workflow.py

安全考量

• 避免在日志中记录敏感信息
• 对输入进行验证和清理
• 防止路径遍历攻击
• 安全处理用户输入数据

许可证

本项目采用 MIT 许可证 - 详情请查看 LICENSE 文件

作者信息

• 作者: chiefzzs
• 邮箱: sz_zzs@163.com

贡献指南

欢迎提交问题报告和功能建议！如有兴趣贡献代码，请：

1. Fork 本仓库
2. 创建功能分支
3. 提交更改
4. 发送 Pull Request

联系方式

如有任何问题或建议，请通过 GitHub Issues 与我们联系。