SuperAPI AI 工具集

prompting

智能体与模型

查看项目

更新于 10-17 17:48

技能介绍

PROMPTING.md 是一个面向 AI 的指令文档设计标准,旨在规范系统提示、任务提示、仓库指令(AGENTS.md/CLAUDE.md)、技能、智能体配置、工具描述、计划、规格、记忆与状态文档、评估器等 AI 面向控制文本的编写、审查与测试。

用途

该标准用于指导如何设计、编写、审查、审计、调试、修订、压缩或测试 AI 面向的指令文档。它强调不应机械地应用于普通面向读者的文本,而应针对具体工件和部署环境选择相关规则,并遵循目标产品当前的规范。

主要能力

标准定义了明确的优先级:当需求冲突时,编号较小的优先级优先,依次为:正确的权威、授权、安全、隐私和真相边界;正确的目标行为和事实依据;可观察的成功和有效评估;材料路线、异常和失败路径的完整覆盖;最小充分控制和上下文;人类可审查性、可移植性、成本和风格。禁止将关键边界失败平均到其他良好评分中。

标准还定义了规范性词汇分类,包括不变量(Invariant)、要求(Requirement)、先询问边界(Ask-first boundary)、默认(Default)、指南(Guideline)、运行时事实(Runtime fact)和阐述(Exposition)。这些分类用于明确指令的约束力,避免依赖语气或强调。

核心规则是将提示词视为配置工程,而非文字修饰。行为属于配置系统,不应仅因指令听起来清晰、遵循模板或包含强调语言而认为其有效。必须区分编写的工件与模型接收的输入,包括表示形式(源工件到渲染后的角色标记消息)和生命周期(可用、选择、加载、执行、检查、保留)。

标准还提供了参考文件的加载指引,例如当指令可能冲突、不可信内容到达模型时,阅读 authority-and-trust.md;当工件服务于相邻任务时,阅读 task-routing.md;对于长时、多阶段或交接工作,阅读 state-and-lifecycle.md;当选择自由度或决定理由、示例等是否值得保留时,阅读 calibration.md;当选择加载内容或规则增加伴随遗漏时,阅读 context-and-density.md;当工件标记、格式或渲染消息存疑时,阅读 input-representation.md;在缩短持久指令、上下文包、交接或状态记录前,阅读 compression.md;当定义工具接口、权限、秘密、隐私或不可信内容防御时,阅读 tools-and-security.md;当设计行为测试、基线、评分器或比较时,阅读 evaluation.md;当运行审计和修复流程或根据观察到的失败进行修订时,阅读 revision.md;在采用任何提示约定作为普遍法则前,阅读 anti-rules.md。

使用方式

标准要求首先建立目标配置,包括识别工件、操作读者、运行环境、表示形式、权威、任务群体、结果、运行时资源和评估。需要验证不可推断的运行时事实,不得虚构发现行为、优先级、上下文限制、工具能力等。如果工件需在多个环境中工作,应分离可移植的语义核心和环境特定的适配器。

在设计前需解决实质用户意图,运行意图检查点,根据权威用户声明和可用证据确定连贯目标、范围、用户可见行为、非目标、约束、验收标准和授权权衡。当材料必需事实未知、存在多种合理解释或权威输入冲突,且可能实质性改变目标等时,应在受影响的设计承诺前询问。澄清应根据未解决决策面进行缩放,当证据能解决预期结果且剩余选择为分配的技术判断或低风险可逆细节时,不应提问。

在编写散文前定义行为契约,从已解决的意图和记录决策构建契约,不得将未解决的用户选择静默转换为需求。以操作术语陈述受治理行为:目标+范围+权威+输入+路线+行动+输出+成功+失败+停止。对于每个材料要求,确定触发事件、行动者、前提条件、所需行动或决策、合规可观察结果、适用异常、信息/权限/能力缺失时的处理以及结束程序。

在添加文本前诊断失败,分类需求,考虑机制,例如缺失事实或领域知识时使用上下文、参考、检索等;错误源选择时调整触发、路由描述等;执行和状态问题使用事件绑定前提、状态转换等;输出和授权问题使用空路径、严格模式、验证器等;生命周期问题使用状态水合、压缩状态记录等。

适用场景

该标准适用于需要设计、审查或测试 AI 面向指令的各类场景,包括系统提示、任务提示、仓库指令、技能、智能体配置、工具描述、计划、规格、记忆与状态文档、评估器等。它帮助确保指令的权威性、安全性、可观察性和可评估性。

限制

标准明确指出,不应机械地应用于普通面向读者的文本。必须遵循目标产品当前的规范来了解语法、加载、优先级、工具和运行时行为。每个部署的工件应在目标配置中评估。标准中的参考文件未在简介中完整再现,需在 references/ 中查阅。标准本身不提供具体产品的语法或运行时细节。