腾讯混元技术文档须遵循五项标准：一、按读者角色分层并标注【读者对象】；二、采用“能力概览—输入输出定义—调用约束—典型场景示例”四段式结构；三、统一术语、版本号与api命名；四、嵌入实测可运行的交互示例；五、严格实施版本控制与变更标注。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您需要为腾讯混元（Hunyuan）大模型相关产品编写技术文档或产品说明书，则必须遵循统一的结构规范、术语体系与表达逻辑，以确保文档的专业性、一致性与可交付性。以下是标准化撰写该类技术文档的具体操作路径：
一、明确文档定位与读者分层
技术文档需根据目标读者角色区分内容深度与表述方式，避免技术细节泛化或过度简化。同一份文档不应同时面向算法工程师、API集成开发者与业务产品经理输出无差别的内容。
1、识别核心读者类型：标注文档适用对象，例如“面向SaaS平台后端开发者”或“面向AI应用产品经理”。
2、在文档首页顶部单独设置“读者对象”字段，使用固定格式：【读者对象】：XXX角色。
3、依据读者类型裁剪章节：面向开发者的文档必须包含请求示例、错误码表、Token计费规则；面向业务方的文档则需屏蔽模型训练参数、LoRA微调接口等底层能力说明。
二、采用标准四段式结构组织正文
所有Hunyuan产品说明书须强制采用“能力概览—输入输出定义—调用约束—典型场景示例”四级主干结构，不得增删层级或调整顺序，以保障跨产品文档的一致阅读体验。
1、在“能力概览”部分，仅描述模型当前版本支持的具体任务类型（如：多轮对话摘要生成、中文法律条款实体抽取），禁用“强大”“智能”等主观形容词。
2、“输入输出定义”中，每个字段必须标注数据类型、必填标识、长度限制及示例值，例如："prompt（string，必填，最大长度8192字符，示例："请总结以下合同中的违约责任条款"）"。
3、“调用约束”需单列“频率限制”“并发上限”“上下文窗口大小”三项硬性指标，并注明是否支持流式响应，例如："单Key QPS上限为5，上下文窗口为32768 token，支持stream=true流式返回"。
三、统一术语与命名规范
术语不一致将直接导致集成方理解偏差与调试失败，所有文档须严格引用腾讯混元官方术语表（Hunyuan Glossary v2.3），禁止自行定义或缩写关键概念。
1、模型版本号必须完整呈现，例如使用“hunyuan-pro-202407”而非“最新版Pro模型”或“Pro-v2”。
2、API路径中的服务名统一为小写加连字符格式，例如“/v2/chat/completions”，禁止出现大写字母或下划线。
3、错误码必须与Hunyuan OpenAPI错误码中心完全一致，如认证失败固定返回“ERR_AUTH_INVALID_KEY”，不得写作“invalid_key”或“auth_error_401”。
四、嵌入可验证的交互示例
每个功能模块必须提供至少一组真实可运行的请求-响应示例，且示例需经腾讯云API调试控制台实测通过，不可虚构或简化关键字段。
1、Curl命令示例须包含完整Header（含Authorization、Content-Type）、JSON Body及对应响应体，其中API Key字段用“YOUR_API_KEY”占位，不得省略任何必需头信息。
2、响应示例中需高亮标注关键业务字段，例如在JSON返回中对“choices[0].message.content”添加注释说明其为模型生成正文主体。
3、若涉及多步骤调用（如先创建会话再发送消息），必须用连续编号示例呈现时序关系，例如第二步示例开头注明：“承接上一步返回的session_id：sess_xxx”。
五、实施版本控制与变更标注
技术文档属于代码资产的一部分，每次更新必须同步记录变更点，确保使用者能快速识别差异，避免因文档滞后引发线上故障。
1、文档页脚固定位置添加版本标识栏，格式为：【文档版本】v2.1.4｜【生效日期】2024-08-15｜【更新项】新增token计费说明章节。
2、对已废弃接口或参数，在对应章节标题前添加“【已下线】”前缀，并保留原始说明内容，禁止直接删除。
3、当模型能力发生不兼容变更（如输入字段类型由string改为array），必须在变更章节顶部插入红色警示条：“⚠️ 重大变更：prompt字段现接受字符串数组，原单字符串输入将触发400错误”。
