跳到主要内容
版本：4.x

AGENTS.md

作用范围​

  • 本文件补充仓库根 AGENTS.md 的默认规则，仅适用于 docs/** 下的当前版本文档。
  • 本文件不覆盖 versioned_docs/**、versioned_sidebars/** 或仓库根配置文件的专门要求。

写作风格​

  • 使用简洁、专业、自然的中文技术文档表达。
  • 避免宣传腔、空话和明显的 AI 腔。
  • 优先写清楚用户要做什么、为什么这样做、前提条件是什么、需要注意什么。
  • 延续附近页面已有术语，不轻易替换成熟叫法。

当前版本文档 Review 重点​

  • 当前产品能力、默认值、限制条件、UI 名称以当前版本为准；不确定时应标明未验证，而不是猜测。
  • 操作步骤应写清前提、顺序和结果；涉及不可逆操作、权限、网络、费用或数据风险时，应有明确提示。
  • 站内链接、标题锚点、相对路径、图片引用、文档 id（默认为文件名） 与 sidebar 引用关系应保持一致。
  • docs/reuse-content/** 中的内容可能被多页复用；review 这类改动时，要考虑下游页面是否也会受影响。
  • docs/images/** 中图片的路径、大小写、扩展名应与引用保持一致。

内容规则​

  • 不要随意修改代码块、命令、参数名、接口字段名、UI 名称、版本号或限制说明。
  • 尽量保持与相邻页面一致的标题层级、列表形式、术语和链接风格。
  • 对能力说明、限制说明、兼容性说明，优先保证准确性，而不是为了“更顺”重写。
  • 如果页面内容声称某功能“支持”“默认开启”“无需配置”或“存在限制”，应尽量基于页面上下文、产品事实或实现依据判断；无法确认时应明确写出未验证。

连接器文档​

  • 仅当本次变更涉及 docs/prerequisites/** 时，才应用以下检查。
  • 在条件允许时，可将文档中的能力说明与对应连接器实现或元数据来源进行轻量核对。
  • 公开可参考来源之一是 Tapdata connectors 仓库。
  • 如果对应连接器源码不可见、位于私有仓库，或无法可靠定位实现，则跳过该项核对，并注明未验证。
  • 仅标记明显不一致的情况，例如 CDC、写入能力、增量支持、数据类型、认证方式、网络或权限前提、限制条件等内容明显冲突。
  • 不要将“缺少外部旁证”本身当作缺陷。