---
title: "快速入门"
description: "首次成功的指南——从零到一个可用结果的最短诚实路径，并展示输出。包含清单和搭建命令。"
---

> Documentation Index
> Fetch the complete documentation index at: https://nimbus-docs.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 快速入门

> **需求**
>
> 在行动中检验——但目的是测试，而非学习。读者正在评估或刚刚注册，想要证明产品能用：一个真实的结果，快速获得。他们的问题是：*"多快能看到它做点什么？"* 衡量指标是首次成功时间，而且它是有代价的：更长的快速入门会显著流失读者。

<h2 id="when-to-use-it">何时使用</h2>

每个产品在每个主要路径上恰好有一个快速入门（例如 API 一个，控制台一个）。它不是：

- **教程。** 没有学习目标，除了一行"刚才发生了什么"外不做解释。读者不是在学习；他们在测试。
- **操作指南。** 操作指南服务于工作中有具体目标的读者。快速入门的唯一目标是*首次*成功，而且它替读者选择目标。

决定性的约束：**作者替读者做出每一个选择。** 一种语言（其他语言用标签页）、一种安装方式、全部使用默认值。当一个选择确实无法默认化（地区、组织类型）时，替读者做出推荐选择，并在末尾一行注明替代方案——永远不要在步骤中间分叉。

**"开始使用"变体。** 有些产品在没有真实配置（DNS、租户设置、不可避免的决策）的情况下无法达到诚实的首次成功。对于这些产品，将同一指南写为**"Get started"** 页面：标题固定为 "Get started"，预算放宽到最通用用例的*最小可行配置*，前置条件可以包含真实决策——每个都折叠为推荐默认值并附一行说明何时选择其他方案。下面的所有其他规则（替读者做选择、展示输出、一个主要下一步）不变。有快速路径的产品两者都提供：快速入门证明它能用，开始使用正确配置它。

<h2 id="title--description">标题和描述</h2>

- **标题：** 只有一个时写 "Quickstart"；按框架或入口路径区分时写 "Quickstart: *路径或技术栈*"（"Quickstart: Next.js"、"Quickstart: Dashboard"）。"Get started" 变体的标题始终是 "Get started"。
- **描述公式：** "*成果*在*时间范围内*。"——例如 "五分钟内发送你的第一个 webhook。" 只承诺你亲眼见过陌生人达到的时间。

<h2 id="scaffold-this-page">搭建此页面</h2>

安装指南——你的编码智能体会读取完整的骨架和清单，并将其适配到你的产品：

```sh
npx add content-quickstart
pnpm dlx add content-quickstart
yarn dlx add content-quickstart
bunx add content-quickstart
```

"You should see" 和 "Next step" 是约定的固定标题——读者（和智能体）学会直接跳到它们。

<h2 id="component-guidance">组件指导</h2>

- **Steps** 和**带可见输出的围栏代码块**构成整个页面。"You should see" 块是最重要的元素——它是证明。
- **Tabs** 仅用于语言/技术栈维度，且仅在示例真正平行时使用。其他任何选择：作者决定。
- **不适用：** Cards、折叠面板、关于边界情况的提示框、步骤中的链接。任何不在最短路径上的内容都在错误的页面上。

<h2 id="ending">结尾</h2>

固定页脚：**You should see**（预期输出 + 一行"刚才发生了什么"）→ **Next step** 恰好一个主要链接。有策略地使用下一步位置——引导到深化采用的内容，而非通用文档首页；最好的站点将快速入门结尾视为旅程路由。

<h2 id="thresholds">阈值</h2>

- **≤ ~600 字、≤ 6 个步骤、一个功能。** 字数预算适用于**一个渲染路径**——一个标签页选择——而非多语言页面的源码。
- **当自然集成超出预算时，缩小首次成功**——一个托管页面、一个 CLI 触发的循环、一次调用——而非注水快速入门或归咎于产品。完整集成属于开始使用页面或操作指南。
- **无错误处理、无选项、无生产加固。** 最后可以诚实写一行说明跳过了什么，就像安静的"测试模式"标签那样。
- **步骤必须每次都成功。** 快速入门借用了教程的可靠性规则：陌生人的头五分钟不是"你的体验可能不同"的地方。

<h2 id="links--freshness">链接和新鲜度</h2>

页脚之前几乎没有链接——首次成功之前的每个链接都是退出口。这种类型是所有类型中退化最快的（安装命令、CLI 输出、注册流程）：在每次涉及该路径的发布时端到端重新运行，并在操作时盖上 `lastVerified`。

<h2 id="agent-notes">智能体备注</h2>

- 智能体逐字运行快速入门；此页面实质上是一个带散文的脚本。每个命令必须可复制运行——占位符用 `<尖括号>`（`hl_test_<your-key>`），命令中永远不要用裸省略号。
- 将运行时变化的输出字段（耗时、生成的 ID）标记为占位符（`<n>ms`），这样智能体将输出与你的对比时不会把正常差异当作失败。输出块中的其他内容保持原样。
- 在 `.md` 版本中，语言标签页展平为带标签的顺序块——预期输出必须在每个路径中出现一次，不能只在默认标签页中。
- 将前置条件表述为可验证的事实（"Node 20+"），而非模糊描述（"较新的 Node"）。

<h2 id="checklist">清单</h2>

建议性——供作者或智能体自查，不是构建门禁：

- [ ] 描述中有时间承诺，且针对冷启动测试过
- [ ] 读者零决策（仅语言/技术栈用标签页；无法默认化的选择已替读者做出并附替代方案）
- [ ] 每个渲染路径 ≤ ~600 字、≤ 6 个步骤、一个功能——或者首次成功已缩减到符合要求
- [ ] 测试模式凭据已建模；占位符用尖括号，命令中无省略号
- [ ] "You should see" 标题存在；输出逐字展示，运行时变化字段已用占位符
- [ ] "What just happened" ≤ 2 句
- [ ] 以恰好一个主要下一步结尾
- [ ] 在当前发布版本上端到端验证过；已盖上 `lastVerified`

Source: https://nimbus-docs.cn/writing/recipes/quickstart/index.mdx