你是一名后端开发工程师,正在为v2.4版本API编写字段说明文档。请对以下字段逐个输出:字段名|数据类型|长度/精度|是否必填|默认值|业务含义|校验规则|示例值。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你想让有道云AI生成的表格字段说明不是“用于存储用户信息”这种套话,而是像开发同事在PR描述里写的那样:字段名、类型、长度、是否为空、业务含义、校验规则、示例值,全齐,粘贴进Confluence就能当接口文档用。
先锁死字段定义的最小颗粒度
在提示词开头就写:“你是一名后端开发工程师,正在为v2.4版本API编写字段说明文档。请对以下字段逐个输出:字段名|数据类型|长度/精度|是否必填|默认值|业务含义|校验规则|示例值”。
必须按这个顺序输出,缺一列就重来——AI常把“校验规则”和“业务含义”混着写,强制排序能切断它的自由发挥路径。
字段名必须原样照抄,大小写、下划线、驼峰都不能改。【字段名大小写错一个字母,前端调用时会直接500】
用真实校验逻辑代替抽象描述
方法一:直接写死正则或SQL约束
在提示词中插入:“手机号字段(phone)的校验规则必须写成‘REGEXP ‘^1[3-9]\d{9}$’’;订单金额(amount)必须写成‘DECIMAL(12,2) ≥ 0.01’;状态字段(status)必须列出全部枚举值:‘0-待支付|1-已支付|2-已取消|9-异常关闭’。”
方法二:标注来源依据
追加一句:“所有校验规则必须对应当前代码库master分支的实际实现。若某字段在数据库建表语句中设为NOT NULL,则‘是否必填’填‘是’;若Java DTO中该字段加了@NotBlank注解,则‘校验规则’需同步体现。”
这一步不做,AI大概率编出“需符合业务规范”这种废话。
给示例值加业务上下文
第一步:禁止用“张三”“123456”这类无意义占位符。
第二步:要求每个示例值带场景说明,格式为:“示例值(场景说明)”,例如:“‘WX202606181523449988776655’(微信支付成功回调返回的trade_no)”、“‘2026-06-19T02:45:33+08:00’(订单创建时间,ISO8601带时区)”。
第三步:数值类字段必须体现单位与精度,“199.99(单位:元,保留两位小数)”、“0.0035(转化率,保留四位小数)”。
【示例值没单位没精度,测试同学根本没法写case】
强制输出结构与格式
① 输出必须为标准Markdown表格,第一行为表头,第二行为分隔线(|---|---|…),第三行起为数据行;
② 所有单元格内容不加引号、不换行、不含竖线字符;
③ “业务含义”列禁用“表示”“用于”“记录”等动词,必须用主动宾短句,例如:“标识用户在本系统内的唯一身份,与身份证号一一映射”而非“用于标识用户身份”;
④ 整体输出字符数严格控制在1100~1180之间,少于1100补空格,多于1180删最后一行字段说明。
















