CIAO - 代码输入架构输出 - 使用 大语言模型 的自动化软件架构文档

软件架构文档对于理解系统至关重要，但它通常不可用或不完整。虽然最近基于 LLM 的技术可以从代码生成文档，但它们通常解决本地工件，而不是生成连贯的系统级架构描述。本文提出了一种使用 大语言模型 直接从 GitHub 存储库自动生成系统级架构文档的结构化流程。该流程称为 CIAO（Code In Architecture Out），定义了一个基于 LLM 的工作流程，该工作流程将存储库作为输入，并按照源自 ISO/IEC/IEEE 42010、SEI Views \& Beyond 和 C4 模型的模板生成系统级架构文档。生成的文档可以直接添加到目标存储库。我们通过对 22 名开发人员的研究来评估该流程，每个开发人员都会审查为他们贡献的存储库生成的文档。评估表明，开发人员普遍认为生成的文档有价值、易于理解且相对于源代码而言大致准确，同时也强调了图表质量、高级上下文建模和部署视图方面的局限性。我们还评估了该流程的运营成本，发现生成完整的架构文档只需要几分钟，而且运行成本低廉。总体而言，结果表明，结构化的、面向标准的方法可以有效地指导 LLM 生成既可用又经济高效的系统级架构文档。