SuperAPI AI 工具集

parametrize-and-cite

办公与效率

查看项目

更新于 10-15 10:44

技能介绍

用途

parametrize-and-cite 适用于任何将“结构模式”与“具体实例”混合在一起的编译型制品,包括:演示文稿、单页介绍、销售资料、README 文件、竞争分析、市场报告、研究摘要、配置文件、清单文件、部署模板、入门文档、运行手册、标准操作程序、剧本等。只要制品具有可复用的“骨架”并包含品牌化表面,或包含事实性断言,就应应用此技能。

两条通用准则:

  1. 所有动态信息都是可配置的环境变量。名称、链接、统计数据、成本、标识符、日期、阈值、联系方式绝对不硬编码。结构可复用,具体细节通过注入提供。
  2. 所有断言都需要多个引用。每项事实性声明至少携带两个独立来源。单来源声明需标记,不得直接发布。

主要能力

五阶段转换管线

阶段一:审计 在转换前通读制品,构建两份清单:动态信息清单(每个具体细节)和断言清单(每项事实性声明及其当前引用数量)。断言是指被期望读者相信的事实性陈述,如数字、归属、比较和历史声明;意见和建议不算断言。

阶段二:识别动态信息 按动态类型分类,使用以下分类法及环境变量前缀:

  • 身份类(公司名、人名、项目名、品牌):IDENTITY_*
  • 定位类(URL、仓库路径、邮箱、电话、地址):LINK_* / CONTACT_*
  • 定量类(收入、数量、百分比、比率、评分):STAT_*
  • 货币类(价格、成本、预算、费用、薪资):COST_*
  • 时间类(日期、截止日期、时长、周期):DATE_* / DURATION_*
  • 阈值类(限制、配额、目标、SLA):THRESHOLD_*
  • 凭证类(API 密钥、令牌、账户 ID):SECRET_*(永不设默认值)
  • 分类类(层级、计划、地区、管辖区):CATEGORY_*

任何在此制品复用实例间可能不同的内容都是动态的,即使当前看似永久。例如“我们公司的名称”也是动态的——制品可能被收购方、分支、并行项目或面向客户的变体复用。

阶段三:参数化 将每个动态细节替换为环境变量引用。根据制品媒介选择模板语法:

  • Markdown / 散文文档:{{ IDENTITY_COMPANY_NAME }}(Mustache 风格)或 ${IDENTITY_COMPANY_NAME}(shell 风格)
  • YAML / JSON 配置:${IDENTITY_COMPANY_NAME}(envsubst 风格)或平台原生语法(!Ref、${{ vars.X }} 等)
  • 代码文件:语言惯用方式(os.environ["IDENTITY_COMPANY_NAME"]、process.env.IDENTITY_COMPANY_NAME)

生成配套的 .env.example(或平台等价物:config.example.yaml、terraform.tfvars.example 等),每个变量一行,包含描述其控制内容的一行注释,以及从原始制品中提取的示例值。示例:

Identity

IDENTITY_COMPANY_NAME="Example Corp" # Replaces brand references in headers, footers IDENTITY_PRODUCT_NAME="ExampleProduct" # Used in feature descriptions

Stats — quarterly report figures

STAT_Q4_REVENUE_USD=4200000 # Q4 top-line revenue STAT_Q4_GROWTH_PCT=23 # YoY growth percentage

Costs — pricing tier defaults

COST_TIER_STARTER_USD_MONTH=49 # Starter plan monthly price

对于 SECRET_* 变量,示例文件只显示变量名和占位符(如 SECRET_API_KEY=changeme-in-production),绝不使用真实密钥。

阶段四:引用 为清单中的每项断言附加至少两个独立引用。独立性定义:

  • 同一母组织的两个来源不算独立(公司官网 + 公司博客 = 一个来源)。
  • 一手来源 + 报道该一手来源的二手来源不算两个独立来源,那是一手来源加回声。
  • 两个独立来源 = 两个无编辑或财务关系的组织,各自可直接访问底层证据(或各自引用不同的原始来源)。

引用格式取决于媒介:

  • 散文文档:内联脚注 [^1] + 参考文献部分
  • 幻灯片/演示文稿:幻灯片底部来源行,完整来源见附录
  • 数据表格:每行来源列 + 每列来源注释
  • 代码注释:# Source: <url> (accessed YYYY-MM-DD); cross-checked: <url>

找不到两个独立引用时,必须明确执行以下之一,不得静默处理:

  • 在输出中用 [CITATION-REQUIRED] 标记,并列入“验证缺口”部分。
  • 将断言降级为条件陈述:“如果 [来源] 正确,那么……”
  • 如果断言是关键但无法支持,则移除。

绝不虚构或伪造来源。绝不用模糊措辞(“研究表明”“众所周知”)掩盖。

阶段五:输出 产出四件套:

  1. 转换后的制品——原始内容,动态信息已参数化,断言已引用。
  2. .env.example(或平台等价物)——每个变量带注释和示例值。
  3. CITATIONS.md——按章节组织的完整参考文献,含访问日期和独立性简要说明。
  4. TRANSFORMATION_LOG.md——变更内容、标记内容、移除内容及理由。

四件套输出不可协商。缺少 .env.example 会让用户无从下手;缺少 CITATIONS.md 引用无法验证;缺少日志用户无法审计变更。

使用方式

按五阶段顺序运行制品,不跳过阶段。每阶段捕获不同类别的问题。完成后按输出验证清单核查:

  • 原始每个具体细节要么已参数化,要么明确保留并说明理由
  • .env.example 每个变量一行,含注释和示例
  • 示例文件中无真实密钥值
  • 每项断言有 ≥2 个独立引用,或已标记/降级/移除
  • 参考文献列出所有引用来源的 URL 和访问日期
  • 转换日志枚举每次变更
  • 仅用环境变量名重读转换后制品,结构仍通顺

最后一项检查很重要:如果移除具体细节后制品变得不连贯,说明制品本质上是关于具体细节的,参数化就是错误做法——应向用户说明,而不是发布降级版本。

适用场景

  • 演示文稿、单页介绍、销售资料、README 文件
  • 竞争分析、市场报告、研究摘要
  • 配置文件、清单文件、部署模板
  • 入门文档、运行手册、SOP、剧本
  • 任何混合“模式”与“特定实例”的文档
  • 任何做出声明(数字、归属、描述)的文档

限制

  • 若制品在移除具体细节后失去连贯性,则不适合参数化,应告知用户。
  • 独立引用的判断需谨慎:同一母组织、一手来源加其回声不算独立。
  • 无法找到两个独立引用时,必须显式标记、降级或移除,不能静默处理。
  • 不得虚构来源或用模糊措辞掩盖。
  • 参考文件:references/transformation-patterns.md(按制品类型的详细模式示例)和 references/citation-independence.md(引用独立性判断)。

边界情况

被视为动态的边界情况(即使感觉永久):

  • “当前年份”——DATE_PUBLICATION_YEAR,而非字面 2026
  • “我们团队规模”——STAT_TEAM_HEADCOUNT,即使每年变化
  • 许可证名称——IDENTITY_LICENSE_TYPE,以防模板在不同条款下复用
  • 品牌特有的语气短语——动态;句子结构可复用
  • 与管辖区相关的合规阈值——THRESHOLD_GDPR_RETENTION_DAYS,以防模板移至另一制度

不确定是否动态时,参数化它。额外环境变量的成本几乎为零,而需要变化却硬编码的代价是重新发布整个制品。

被视为断言的边界情况(需要引用):

  • “X 是 Y 市场最大的提供商”
  • “23% 的用户在 30 天内流失”
  • “这符合法规 Z”
  • “方法 A 比方法 B 更快”
  • “收购于日期 D 以价格 P 完成”

不算断言(无需引用):

  • “我们推荐 X 因为……”(建议)
  • “考虑 Y 是否适用于你的场景”(建议)
  • “本文档描述我们对 Z 的方法”(描述性)
  • “第 3 节涵盖配置”(结构性)

如果一句话既建议又断言,拆开它:“采用方法 X(建议)。方法 X 经测量延迟降低 40% [^1][^2](断言)。”