撰写通义千问组件文档时,有一条核心规范:严禁使用解释性句式。简单来说,就是将“能够”“可用于”这类冗余表达彻底删除,替换为“组件名+动词+宾语”的简洁短句,同时强制统一术语,并对每个段落限定字数与格式。

为通义千问编写组件文档时,如果提示词没有设置严格约束,模型往往会习惯性输出“该组件支持……”“本模块可以用于……”这类套话。最终导致功能描述、参数说明、示例代码注释风格单一,读起来枯燥乏味。
用主谓宾结构锁定每句核心动作
首先,将提示词中所有包含“能够”“可用于”“具备……能力”的词汇彻底清除。这些结构是重复表达的根源——它们会触发模型自动补全一连串解释性从句。
接着,将每个功能点压缩为“组件名+动词+宾语”的短句。举例来说:Button组件点击触发onPress回调;Form组件校验失败时高亮错误字段;Toast组件显示后3秒自动消失。足够清晰直接吧?
最后一步,在提示词末尾追加一条指令:每句话必须以组件名开头,只含一个动词,宾语不允许重复出现两次。如果必须重复,则用“其”或“该结果”代替。为什么如此严格?因为模型对重复的宾语会自动生成冗余解释,这一点必须牢牢卡死。
禁用三类高频模板句式
第一,在提示词里明确排除起始结构。直接添加:禁止以“该组件”“本模块”“此功能”开头;禁止连续两句话用同一个动词开头;禁止使用“支持XX”“提供XX能力”“适用于XX场景”这类句式。
第二,强制替换连接逻辑。将“因此”“所以”“从而”统一改为“→”符号,每段最多出现一次。此外,“此外”“值得一提的是”这类过渡词,全部删除。
操作方式很简单——把禁用词列表直接粘贴到提示词末尾即可。
注入术语锚点并绑定行为约束
在提示词开头嵌入一个术语对照表,例如:“【锚点】Button → 不得写作‘按钮组件’或‘点击控件’;onPress → 不得扩展为‘点击时执行的函数’;disabled → 统一译为‘禁用态’而非‘不可点击状态’。” 然后紧跟一句硬性指令:“如果检测到锚点词出现非标准变体,必须整句重写,不能只做局部替换。” 这样一来,模型想凑字数都困难——同一术语反复展开解释的路径就被彻底堵死了。
分段设定输出密度上限
参数说明部分,要求每个参数单独成行,格式为“参数名(类型):作用说明”,说明不得超过12个字,冒号后面不许接从句。示例代码部分,只保留代码块和一行注释。注释以“//”开头,内容限定为“目的:XXX”,XXX不超过8个字。注意事项部分,只列三点。每点以“⚠️”开头,不换行,总长度控制在65字以内。
这种分层压缩的做法,远比笼统说一句“请简洁”有效得多——模型会优先确保每个段落字数达标,那些铺垫和重复叙述自然就会被舍弃。
