SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-15 20:14

技能介绍

用途:为 Opik 项目提供文档与发布说明的写作模式,适用于记录变更、撰写 PR 描述或准备发布。

主要能力与结构: PR 描述包含 Summary(要点列表)、Test Plan(验证方式)、Related Issues(如 Resolves #123)。变更日志条目按 [VERSION] - [DATE] 组织,分 New Features、Improvements、Bug Fixes、Breaking Changes。功能文档需覆盖用户影响(新增能力、访问方式)、技术变更(API 端点与参数、SDK 新方法、数据库迁移、配置变更)以及破坏性变更与迁移步骤。

关键文件:CHANGELOG.md 用于自托管部署的破坏性/关键变更;apps/opik-documentation/documentation/fern/docs/changelog/ 存放主产品文档的带日期 .mdx 变更日志;apps/opik-documentation/documentation/fern/docs/agent_optimization/getting_started/changelog.mdx 用于 Agent Optimizer 发布日志;docs.yml 为变更日志入口的路由与导航来源;.github/release-drafter.yml 为发布模板。

变更日志路由规则:按范围选择目标,不要默认写入根 CHANGELOG.md;根文件仅用于自托管部署的破坏性/关键/安全相关说明;通用产品发布说明写入 changelog/*.mdx;Agent Optimizer 版本更新写入对应 changelog.mdx;Liquibase changelog.xml 是迁移清单而非面向用户的发布说明;不确定时先查 docs.yml 确认入口。

文档图片:使用 fern/img(如 apps/opik-documentation/documentation/fern/img/...),不要用 static/img 存放新资源;文档中以 /img/... 引用。定义 docs.yaml/docs.yml 的仓库应将其视为路由来源,不要假设 URL 与目录结构一致。

多语言 README:readme_CN.md、readme_JP.md、readme_KO.md、readme_PT_BR.md 由英文 README.md 经 AI 机器翻译;每个非英文 README 顶部需有引用块提示为 AI 翻译并欢迎改进;英文 README 有重大更新时重新翻译;不要手动编辑译文内容,应更新英文源再重译。

风格:从用户视角而非实现细节出发,具体到版本号与日期,API/SDK 变更附代码示例,简洁并链接文档而非重复。