用大模型做技术文档与API文档生成指南.docxVIP

用大模型做技术文档与API文档生成指南

使用说明

1.本指南可直接作为【组织名称】内部规范、SOP或团队工作手册使用。

2.将文中【】内容替换为实际信息，如组织、产品、工具、审批人、模型名称等。

3.可根据技术栈删除不适用章节，但建议保留：总体原则、Prompt模板、API文档生成流程、质量检查、安全合规、评审清单。

4.推荐将本文放入代码仓库docs/目录，纳入Git与CI/CD管理，实现“文档即代码”。

项目

内容

文档名称

用大模型做技术文档与API文档生成指南

文档编号

【DOC-AI-001】

版本

V1.0

密级

【内部公开】

维护人

【文档团队/API平台团队】

审批人

【技术负责人/安全负责人】

生效日期

【YYYY-MM-DD】

适用范围

【组织/部门/产品线】

1.目的

本指南旨在规范使用大语言模型辅助生成、优化、评审和维护技术文档与API文档的方法，确保文档具备：

准确性：内容与代码、接口定义、配置和实际行为一致。

完整性：覆盖用户、开发者、运维人员所需关键信息。

一致性：术语、格式、风格、示例统一。

可维护性：可随代码和接口变更持续更新。

安全性：不泄露敏感信息，不引入合规风险。

可追溯性：可定位生成来源、模型、Prompt版本和评审记录。

本指南不是“让大模型替代文档工程师”，而是建立“大模型生成+自动校