了解如何使用 Hivulse 从代码自动生成技术文档,快速上手,全面提升研发效率
使用平台的导入功能,将代码仓库导入系统。支持直接连接或上传方式。您可以连接 GitHub、GitLab、Gitee 等主流代码仓库,也可以直接上传代码文件。系统会安全地读取您的代码内容并准备分析。
如果代码以 ZIP 包形式存在,可直接上传,支持 ZIP 格式以便快速导入。这种方式适合本地代码项目或需要一次性导入大量代码的场景,无需配置仓库权限,更加便捷。
导入后,系统会自动同步代码。同步完成后,即可在"wiki 知识库"模块开始创建文档生成任务。系统会智能分析代码结构、函数关系和业务逻辑,为后续高质量文档生成做好充分准备。
输入任务名称,选择对应的代码仓库和分支,然后选取需要生成的文档类型,点击确认提交。系统将使用 AI 自动生成文档。支持生成详细设计文档、技术方案、API 文档、架构文档等多种类型。
点击导出功能,在任务中心下载生成的文档。在当前任务中添加更多文档,继续生成其他内容。直接编辑生成的文档并导出保存。支持 Word、PDF、Markdown、HTML 多种格式导出,方便归档与分享。