SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-16 12:41

技能介绍

用途:该技能覆盖 Agentic B2C Developer Toolkit 的文档维护,包括用户指南、MCP 页面、CLI 参考、VitePress 样式以及用于生成 TypeDoc 的 JSDoc。

主要能力与写作原则:面向初级开发者和非开发管理员,先说任务、收益与可见行为,避免协议状态、worker 生命周期等内部细节;共享功能需覆盖 CLI、IDE 与助手三种使用方式;平台设置与需求尽量链接 Salesforce Developer Center 或 Help 页面,不维护重复的安装流程。MCP 工具采用紧凑的工具名/能力表,并在每个工具组标题下用加粗 Toolsets 字段标注可用范围。安全模式以受支持的 B2C 操作和实践示例为主,区分被阻止操作、受支持确认与助手批准,并精确说明首匹配规则优先级。

文档结构与生成:docs/guide 与 docs/cli 为手写内容,docs/api 由 TypeDoc 从 JSDoc 自动生成,禁止直接编辑,需更新 SDK 源码注释后运行 pnpm run docs:api。Python SDK 位于 docs/python,其 API 参考由 docstring 生成但输出提交入库,从 python/b2c-tooling-sdk/ 运行 make api-docs 或 make api-docs-check。

构建与预览:pnpm run docs:api 生成 API 文档,pnpm run docs:dev 启动开发服务器,pnpm run docs:build 构建静态站点,pnpm run docs:preview 预览构建结果。托管预览由 GitHub Actions 发布,PR 预览使用 /pr-<number>/,合并后移除。

视觉与限制:示例请求统一使用全局注册的 ExamplePrompt 组件,并以 Markdown 引用加空行方式书写,写成自然业务/开发请求而非工具指令。终端截图使用 Freeze,须为真实输出,不泄露凭据、个人信息或客户数据;已审核 PNG 放在 docs/public/terminal/ 并以链接指向原图。改动需在桌面与移动宽度下浏览器验证,并用 DOCS_BASE_PATH 子路径构建检查链接。资料未提供具体收费、价格信息。