用途:该技能用于撰写工具的快速开始(quickstart)文档,目标是让开发者在约 5 分钟内从零走到第一个可运行结果。适用于被要求编写 quickstart、入门指南或 onboarding 文档的场景。
所需输入:若未提供,应向用户询问以下信息——工具/库/API 是什么及其用途;安装与设置方式,包括启动所需的密钥、认证或配置;最小可用示例(即第一次成功的最小成果);运行环境、语言/运行时与前置条件;后续深入资源,如核心指南、API 参考和示例。
输出格式:标题为「Quickstart: [产品]」,说明可在约 5 分钟内从零到首个结果。接着依次为:前置条件(仅列真正必需的版本、账号或密钥);1. 安装(实际安装命令);2. 配置或认证(仅在需要时,给出最小设置并说明如何获取密钥);3. 第一个结果(最小且完整、可运行、可复制的端到端示例);4. 应看到什么(预期输出,便于确认成功);后续步骤(3–4 个指向核心概念、API 参考、更多示例和求助渠道的链接或指引);可选故障排查(最常见的 1–2 个首次运行错误及修复方法)。
质量要求:开发者能通过复制粘贴得到可运行结果,无缺失步骤;首个示例是最小示例,只呈现一个明确成果,而非功能巡览;前置条件只列真正必需项;展示预期输出使成功可确认;后续步骤指向正确的深入资源。
应避免:不要一开始堆砌概念或架构,先让读者跑通再加解释;不要假设存在隐藏设置,运行所需的每一步都要写出;不要把庞大复杂的示例作为第一个示例;不要省略预期输出;不要留下死胡同,始终给出下一步方向。
该技能基于开发者文档实践中的 Diátaxis「教程」模式,即追求首次成功时间的快速开始模式。