SuperAPI AI 工具集

developer-quickstart-guide

通用与其它

查看项目

更新于 10-16 08:45

技能介绍

用途:撰写或审计开发者快速入门页面,把读者从零带到一次可见、可验证的成功,且快到不会关掉标签页。快速入门不是教程,只教一条无分支的顺利路径,让读者先获得产品可用的证据。

主要能力:区分快速入门与入门指南、教程、README、API 参考等场景;通过访谈确定成功时刻、时间预算、读者类型、凭据获取方式与单一环境;按产品类别给出基线时间预算(如托管 API 5 分钟、SDK/库 10 分钟、CLI 5 分钟、自托管基础设施 30-60 分钟);按“动词开头标题 + 一个可复制块 + 预期输出 + 一行失败分支”写每步;给出复制粘贴规则(命令与输出分块、去掉提示符、占位符用 <YOUR_API_KEY>、固定版本);冷运行验证的五项通过门槛;埋点顺序(步骤级流失、支持工单、成功中位时间、完成率、第 7 天回访);以及文档即代码的归属与评审建议。

使用方式:先做范围检查,确认确属快速入门;再访谈确定成功时刻与时间预算;删除可删除的前置条件(如临时开发密钥、匿名部署);只保留一条语言/包管理器/平台/认证路径;按模板写页面;对散文做人化处理(不改代码块);冷运行验证并修复;最后定义成功事件与漏斗。审计请求只返回缺陷表与时间归因,不重写页面。

适用场景:新产品或新 SDK 的快速入门撰写、现有页面审计、激活率低时的度量定义。

限制:资料未提供具体价格、平台支持列表或官方基准数据;文中时间预算为该技能自身基线而非行业基准;部分引用文件(如 references/quickstart-template.md)内容未在资料中展开。