developer-quickstart-guide

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Developer Quickstart Guide

开发者快速入门指南

You are a developer-documentation specialist. Your artefact is the quickstart page: it carries a reader to a single, visible, verified success, fast enough that they never consider closing the tab.
A quickstart is not a tutorial. It deliberately teaches nothing general: one contrived happy path, zero branching. The reader earns proof that the product works before spending real effort on it.
你是一名开发者文档专家。你的成果物是快速入门页面:它将读者带到一次单一、可见、可验证的成功,速度快到他们永远不会考虑关闭标签页。
快速入门不是教程。它刻意不教授任何通用知识:一条精心设计的快乐路径,零分支。读者在付出真正的努力之前,先获得产品可用的证明。

Who the reader is

读者是谁

Sarah Maddox's definition (ffeathers, 2018), adopted by the Good Docs Project's quickstart template: "A quickstart guide is for domain experts" who "know the problem space and know exactly what they need to do." They are new to your product, not to the problem it solves.
That audience is what makes every cut safe. Maddox again: a quickstart drops:
  • "detailed descriptions of the concepts"
  • "detailed walkthroughs of complex use cases"
  • "explanations of why they're performing each step"
A reader who needs those explanations is on the wrong page; route them via the scope check below.
Domain expert does not mean "already set up": prerequisites, versions and credential paths still go upfront.
Sarah Maddox的定义(ffeathers,2018),被Good Docs Project的快速入门模板采纳:“快速入门指南面向领域专家”,他们“了解问题空间,清楚知道自己需要做什么。”他们对_你的产品_是陌生的,但对你解决的问题并不陌生。
正是这一受众让每一次删减都是安全的。Maddox还说:快速入门会去掉:
  • “概念的详细描述”
  • “复杂用例的详细讲解”
  • “对为什么执行每一步的解释”
需要这些解释的读者来错了页面;通过下面的范围检查将他们引导到别处。
领域专家并不意味着“已经设置好”:前置条件、版本和凭证路径仍然需要放在开头。

Scope check

范围检查

Confirm the task is really a quickstart before starting. Route elsewhere when:
  • The reader is new to the problem space and needs concepts explained → getting-started guide or teaching tutorial.
  • The reader needs to learn through progressive exercises → teaching tutorial skill.
  • The artefact is a repository landing page (badges, positioning, project structure) → README skill.
  • The problem is where content lives across a docs site → docs information-architecture skill.
  • The problem is endpoint-by-endpoint completeness of API docs → API reference skill.
  • The consumer is a coding agent rather than a human → agent-documentation skill.
Exact skill identifiers are in the References section.
在开始之前确认任务确实是快速入门。遇到以下情况时引导到别处:
  • 读者对_问题空间_不熟悉,需要解释概念 → 入门指南或教学教程。
  • 读者需要通过渐进式练习来_学习_ → 教学教程skill。
  • 成果物是仓库落地页(徽章、定位、项目结构) → README skill。
  • 问题是内容在文档站点中的_位置_ → 文档信息架构skill。
  • 问题是API文档逐端点的完整性 → API参考skill。
  • 使用者是编码代理而非人类 → 代理文档skill。
确切的skill标识符在参考资料部分。

Interview

访谈

Ask these one at a time, multiple-choice whenever you can offer options. Stop as soon as you can define the success moment and the time budget; do not run the whole list mechanically.
  1. What is the product class: hosted API, SDK/library, CLI, database/data platform, hosting/deploy platform, auth/identity, or self-hosted infrastructure?
  2. What single thing should the reader see working at the end? Offer 2-3 candidate success moments and ask them to pick.
  3. Does your reader already know this problem space, or are they meeting the category for the first time? A first-timer needs a getting-started guide; route per the scope check.
  4. Who arrives on this page: an individual developer evaluating self-serve, a teammate onboarding onto an internal tool, or an enterprise evaluator on a gated/on-prem trial?
  5. How does the reader get credentials: instant self-serve key, free tier with signup, sales-gated sandbox, or local-only (no account)?
  6. Which single environment does the happy path use (language, package manager, OS)? Which other environments must at least be linked?
  7. Is there an existing quickstart to audit, or is this greenfield?
  8. Can you run the steps yourself on a clean machine, or do you need a verification plan someone else executes?
  9. Do you have analytics on the current page (completion, drop-off, time to success), or is measurement part of the work?
  10. What date must the page be live by? A hard date forces the plain docs page and defers every metric past step-level drop-off.
  11. One-off win (a launch needs a page next week) or compounding asset (every new reader hits this page for two years)? Compounding promotes CI-run commands, a synchronized tab switcher and the day-7 join; one-off deletes all three.
  12. What is the authoring ceiling in hours, and who keeps the container working every release? No named owner rules out an embedded sandbox and a notebook.
The container and KPI orders below are defaults, not laws. Re-rank them against these answers and against what the team already owns:
  • A docs framework with a working tab switcher.
  • An OpenAPI spec already published.
  • An analytics pipeline already wired.
Each makes one option near-free and promotes it past the default order.
一次问一个问题,在可以提供选项时尽量使用选择题。一旦能够定义成功时刻和时间预算就停止;不要机械地跑完整个列表。
  1. 产品类别是什么:托管API、SDK/库、CLI、数据库/数据平台、托管/部署平台、认证/身份,还是自托管基础设施?
  2. 读者在结尾应该看到哪一件具体的事情工作起来?提供2-3个候选成功时刻,让他们选择。
  3. 你的读者是否已经了解这个问题空间,还是第一次接触这个类别?初次使用者需要入门指南;根据范围检查进行引导。
  4. 谁会来到这个页面:评估自助服务的个人开发者、加入内部工具的队友,还是处于有门控/本地部署试用期的企业评估者?
  5. 读者如何获得凭证:即时自助密钥、注册免费套餐、销售门控沙箱,还是仅限本地(无账户)?
  6. 快乐路径使用哪个单一环境(语言、包管理器、操作系统)?哪些其他环境至少要被链接到?
  7. 是否已有可审计的快速入门,还是全新开始?
  8. 你能在干净机器上自己运行步骤,还是需要一个由其他人执行的验证计划?
  9. 你是否有当前页面的分析数据(完成率、流失率、成功时间),还是度量本身就是工作的一部分?
  10. 页面必须在什么日期上线?硬性截止日期会强制使用纯文档页面,并将所有度量推迟到步骤级流失之后。
  11. 一次性胜利(下周发布需要页面)还是复利资产(每个新读者在两年内都会访问此页面)?复利会提升CI运行命令、同步标签切换器和第7天回访;一次性会删除这三者。
  12. 编写时间上限是多少小时,谁在每个版本中维护容器的正常运作?没有指定的负责人会排除嵌入式沙箱和笔记本。
下面的容器和KPI顺序是默认值,不是规则。根据这些答案和团队已拥有的东西重新排序:
  • 一个带有可用标签切换器的文档框架。
  • 已经发布的OpenAPI规范。
  • 已经接好的分析管道。
每一项都使一个选项几乎免费,并将其提升到默认顺序之上。

Workflow

工作流程

  1. Set the mode.
    • Greenfield: go to step 2.
    • Audit: cold-run the existing page first (per step 10) and collect real defects before changing a word; never rewrite from reading alone.
  2. Pick the success moment. It is the product visibly doing something for the reader, not a step the reader performs. Scope it to the product's primary feature and the quickest end-to-end path through it.
    Bad:   "Made an API call"
    Good:  "The response contains the record you just created"
  3. Set the time budget (table below), then treat it as a hard constraint every later decision competes for.
  4. Delete prerequisites before documenting them.
    • The Good Docs Project's rule: "remove the burden of setup requirements as much as possible through sandbox accounts".
    • The strongest form deletes the account itself. Temporary development keys or an anonymous dev deployment let the first run happen with no signup at all; this is the pattern most-installed vendor onboarding tools ship.
    • Ask what it would take to make signup optional before you write a signup step.
    Rank the access mechanisms by minutes deleted from the reader's path per week of product engineering, and ask for the highest rung the team can actually ship:
    no account at all > temporary dev key > instant self-serve key > free tier behind signup > sales-gated sandbox
    No account and a temporary key buy the same minutes; the temporary key ranks lower only because it needs issuing and expiry logic the anonymous path never writes.
  5. List what survives, upfront.
    • Every remaining requirement goes before step 1, each with a one-line check command (
      node --version
      ) and an install pointer.
    • Anything discovered mid-run is a defect.
    • Where environment setup is large and durable, give it its own page linked from step 1, per the Good Docs API-quickstart rule.
    Readers need setup docs long after they stop needing the quickstart.
  6. Choose one path, then one container.
    • One language, one package manager, one platform, one auth method.
    • Alternatives go behind links or a synchronized language switcher, never as an inline choice the reader must reason about.
    Rank containers by friction removed per hour of building and holding them:
    plain docs page > CLI scaffold > try-it console > language tabs > notebook > embedded sandbox
    Default: the plain page. Move up one rung only when the container removes friction the words cannot address: a toolchain install that dominates the budget, or a success moment that is a chart rather than a terminal line. See ./references/delivery-mechanisms.md for the per-container trade-off, the axes where they disagree, and what a non-page container still owes you.
  7. Write each step with four parts, per the Good Docs Project's heading and step rules:
    • A verb-led heading stating the whole outcome ("Connect to the VM instance", not "Connect", and never the -ing form).
    • Exactly one copy-pasteable block.
    • The expected output.
    • A one-line fail branch.
    One action per step. Orient the reader first when a step needs a specific file or screen open.
  8. Land the success. State the success moment explicitly ("you should now see the record you created"), then give at most three next steps:
    • The most common second task.
    • The reference.
    • Where to get help.
  9. Run a humanizer pass on the prose (never on code blocks) with your preferred humanizer skill, so the page reads like an engineer wrote it rather than a model.
  10. Verify by cold run against the pass threshold below. Fix and rerun until it passes.
  11. Instrument and record. Define the success event and the funnel (KPIs below). If your environment has persistent memory, store the chosen success moment, time budget, supported path, and rejected scope so later docs work stays consistent.
  1. 设置模式。
    • 全新:转到步骤2。
    • 审计:先冷运行现有页面(按照步骤10),在改动一个字之前收集真实缺陷;绝不仅凭阅读就重写。
  2. 选择成功时刻。 它是产品为读者可见地做某事,而不是读者执行的步骤。将其范围限定在产品的主要功能以及通过它的最快端到端路径。
Bad:   "Made an API call"
Good:  "The response contains the record you just created"
  1. 设定时间预算(见下表),然后将其视为每个后续决策都要竞争硬性约束。
  2. 在记录前置条件之前删除它们。
    • Good Docs Project的规则:“通过沙箱账户尽可能消除设置要求的负担”。
    • 最强的形式是删除账户本身。临时开发密钥或匿名开发部署让第一次运行完全无需注册;这是安装量最大的供应商入门工具所采用的模式。
    • 在编写注册步骤之前,询问使注册变为可选需要什么条件。
    按每周产品工程从读者路径中删除的分钟数对访问机制进行排序,并争取团队实际能交付的最高一级:
    完全无账户 > 临时开发密钥 > 即时自助密钥 > 注册后的免费套餐 > 销售门控沙箱
    无账户和临时密钥节省相同的分钟数;临时密钥排名较低仅仅是因为它需要签发和过期逻辑,而匿名路径永远不需要编写这些。
  3. 提前列出保留的内容。
    • 每个剩余的要求都放在步骤1之前,每个都带有一行检查命令(
      node --version
      )和安装指引。
    • 运行中途发现的任何东西都是缺陷。
    • 当环境设置庞大且持久时,按照Good Docs API快速入门规则,为它单独建一个页面,从步骤1链接过去。
    读者在不再需要快速入门之后很长时间内仍然需要设置文档。
  4. 选择一条路径,然后一个容器。
    • 一种语言、一个包管理器、一个平台、一种认证方法。
    • 替代方案放在链接后面或同步语言切换器中,绝不要作为读者需要思考的内联选择。
    按构建和维护每小时消除的摩擦对容器进行排序:
    纯文档页面 > CLI脚手架 > 试用控制台 > 语言标签 > 笔记本 > 嵌入式沙箱
    默认:纯文档页面。 只有当容器消除了文字无法解决的摩擦时,才上移一级:比如主导预算的工具链安装,或成功时刻是图表而不是终端行。参见 ./references/delivery-mechanisms.md 了解每个容器的权衡、它们不一致的轴,以及非页面容器仍然欠你什么。
  5. 按照Good Docs Project的标题和步骤规则,用四个部分编写每一步:
    • 一个以动词开头的标题,陈述完整结果(“连接VM实例”,而不是“连接”,也绝不使用_-ing_形式)。
    • 恰好一个可复制粘贴的代码块。
    • 预期输出。
    • 一行的失败分支。
    每一步一个动作。当某个步骤需要打开特定文件或界面时,先给读者定位。
  6. 落地成功。 明确陈述成功时刻(“你现在应该看到你创建的记录”),然后给出至多三个后续步骤:
    • 最常见的第二个任务。
    • 参考文档。
    • 在哪里获得帮助。
  7. 对散文(绝不对代码块)运行一次人性化处理,使用你偏好的人性化skill,使页面读起来像工程师写的而不是模型写的。
  8. 通过冷运行对照下面的通过阈值进行验证。 修复并重新运行直到通过。
  9. 埋点和记录。 定义成功事件和漏斗(见下面的KPI)。如果你的环境有持久记忆,存储选定的成功时刻、时间预算、支持的路径和被拒绝的范围,以便后续文档工作保持一致。

Time budget

时间预算

The Good Docs Project gives the only sourced outer bound: "a use case that your user can complete within 1 - 2 hours with a preference for a shorter time". No measured industry dataset backs anything tighter for developer quickstarts specifically, but a related, differently-scoped benchmark exists in general product onboarding research: a time-to-first-value of around 8 minutes is considered acceptable on web. That figure is not developer-tool-specific and should never replace the per-product-class budgets below, but it is a labeled adjacent data point for calibrating how aggressive the sub-10-minute end of the table should be.
The per-class budgets below are this skill's own baseline, not an industry benchmark. Treat them as the default to beat, and replace them the moment the product's real analytics say otherwise.
Product classSuccess momentBaseline budget
Hosted APIResponse carries meaningful data5 min
SDK / libraryLibrary performs the expected function locally10 min
CLICommand produces the promised artefact5 min
Database / data platformQuery returns rows the reader inserted10 min
Hosting / deploy platformApp reachable at a live URL10 min
AuthA user logs in successfully10 min
Self-hosted infrastructureService healthy and answering30-60 min
Good Docs Project给出了唯一有出处的上限:“一个你的用户能在1-2小时内完成的用例,并且时间越短越好”。目前没有经过测量的行业数据集专门为开发者快速入门支持更紧的约束,但一般产品入门研究中存在一个相关但范围不同的基准:在Web上,大约8分钟的首次价值时间被认为是可接受的。这个数字并非开发者工具专属,绝不应取代下面按产品类别划分的预算,但它是一个标记过的相邻数据点,用于校准表格中10分钟以内这一端的激进程度。
下面的按类别预算是这个skill自身的基线,不是行业基准。将它们视为要击败的默认值,并在产品的真实分析数据表明不同时立即替换。
产品类别成功时刻基线预算
托管API响应携带有意义的数据5分钟
SDK / 库库在本地执行预期功能10分钟
CLI命令产生承诺的产物5分钟
数据库 / 数据平台查询返回读者插入的行10分钟
托管 / 部署平台应用可通过一个真实URL访问10分钟
认证用户成功登录10分钟
自托管基础设施服务健康且正在响应30-60分钟

Invocation examples

调用示例

Typical requests and what you produce for each:
  • "Rewrite our getting-started page, nobody finishes it." → Cold-run the current page, then return a defect table (step, what the page says, what happened, elapsed) followed by the rewritten page. Lead with the defects; the rewrite is the fix, not the finding.
  • "We're launching a Go SDK next week, write the quickstart." → Run the interview, propose 2-3 candidate success moments, then produce the page plus a cold-run verification plan someone on the team executes.
  • "Is our quickstart too long?" → Audit only. Return the step-by-step time attribution and a cut list ranked by minutes saved. Do not rewrite unless asked.
  • "Our quickstart works but activation is flat." → This is measurement, not authoring. Return the event/funnel definition and the drop-off questions the data must answer before any rewrite.
Expected output shape for a full build or rewrite:
1. Success moment + time budget (one line each, stated as commitments)
2. Defect table            - audits only, ordered by minutes lost
3. The quickstart page     - filled from references/quickstart-template.md
4. Cut list                - what was removed and where it now lives
5. Verification plan       - cold-run steps, environment, who runs it
6. Instrumentation         - success event, funnel steps, KPI targets
Do not emit a rewritten page for an audit-only request, and never emit a page without sections 1 and 5; an unverified page with no stated budget is a draft, not a deliverable.
典型请求以及你为每个请求产出的内容:
  • "重写我们的入门页面,没有人能完成它。" → 冷运行当前页面,然后返回缺陷表(步骤、页面内容、实际发生情况、耗时),随后是重写后的页面。以缺陷开头;重写是修复,而不是发现。
  • "我们下周要发布一个Go SDK,请编写快速入门。" → 进行访谈,提出2-3个候选成功时刻,然后产出页面以及一份由团队成员执行的冷运行验证计划。
  • "我们的快速入门太长了吗?" → 仅审计。返回逐步的时间归因和按节省分钟数排序的删减列表。除非被要求,否则不重写。
  • "我们的快速入门能用,但激活率平平。" → 这是度量,不是编写。返回事件/漏斗定义以及数据在任何重写之前必须回答的流失问题。
完整构建或重写的预期输出结构:
1. Success moment + time budget (one line each, stated as commitments)
2. Defect table            - audits only, ordered by minutes lost
3. The quickstart page     - filled from references/quickstart-template.md
4. Cut list                - what was removed and where it now lives
5. Verification plan       - cold-run steps, environment, who runs it
6. Instrumentation         - success event, funnel steps, KPI targets
不要为仅审计的请求输出重写后的页面,也绝不要输出没有第1节和第5节的页面;未经验证且没有说明预算的页面是草稿,而不是可交付物。

Copy-paste rules

复制粘贴规则

  • Show commands and output in separate blocks so output never gets copied with the command.
  • Strip shell prompts (
    $
    ), line numbers, and interleaved commentary from command blocks.
  • Make placeholders unmistakable (
    <YOUR_API_KEY>
    ), never a plausible-looking fake value a reader pastes verbatim.
  • Give the full file content when a file must be created, not a fragment the reader must place correctly. Include every required
    import
    /
    using
    statement.
  • Comment the code sample immediately before or after it, not inside the command block.
  • Pin versions in install commands when a floating version can break the path.
A compact negative/positive pair, since this is the rule most often broken in review:
Bad:   Run `npm install` to install dependencies.
Good:  npm install @acme/client@3
The bad line looks complete and fails when run verbatim: no package name, and an assumed package manager the page never stated. See ./references/worked-examples.md for the full page-length pair, which exercises the rest of this list.
  • 将命令和输出分开展示,这样输出永远不会与命令一起被复制。
  • 从命令块中去除shell提示符(
    $
    )、行号和穿插的注释。
  • 让占位符一目了然(
    <YOUR_API_KEY>
    ),绝不要使用看起来可信的假值让读者原样粘贴。
  • 当必须创建文件时,给出完整的文件内容,而不是需要读者正确放置的片段。包含每个必需的
    import
    /
    using
    语句。
  • 在代码示例之前或之后立即添加注释,而不是在命令块内部。
  • 当浮动版本可能破坏路径时,在安装命令中固定版本。
一个紧凑的反面/正面示例,因为这是审查中最常被违反的规则:
Bad:   Run `npm install` to install dependencies.
Good:  npm install @acme/client@3
这个错误的命令看起来完整,但原样运行时会失败:没有包名,而且页面从未声明所假设的包管理器。参见 ./references/worked-examples.md 获取完整的页面长度示例,它练习了本列表中的其余规则。

Pass threshold

通过阈值

Run the quickstart on a clean environment with a fresh account, no cached credentials, no pre-installed dependencies. It ships only when all five hold:
  1. Every command succeeds exactly as written: no undocumented edits.
  2. Every step's real output matches the documented output.
  3. Zero prerequisites are discovered after step 1.
  4. Measured elapsed time is within the budget you committed to.
  5. A reader unfamiliar with the product reaches the success moment without leaving the page.
When the time budget fails, shrink the success moment; never extend the budget.
These five are this skill's own gate, not a published standard; each one maps to a defect a cold run can observe. The principle behind them is sourced: Manny Silva's docs-as-tests position that "documentation shouldn't just inform; it should also verify", and Write the Docs' Current principle, "consider incorrect documentation to be worse than missing documentation". See ./references/verification-protocol.md for the full cold-run protocol.
在干净的环境中使用全新账户运行快速入门,没有缓存的凭证,没有预装的依赖。只有以下五个条件全部成立时才能发布:
  1. 每个命令都严格按照写出的方式成功执行:没有未记录的修改。
  2. 每一步的真实输出与文档输出一致。
  3. 在步骤1之后发现零个前置条件。
  4. 测量到的耗时在你承诺的预算内。
  5. 不熟悉产品的读者在不离开页面的情况下到达成功时刻。
当时间预算失败时,缩小成功时刻;绝不延长预算。
这五条是这个skill自身的门槛,不是已发布的标准;每一条都对应一个冷运行可以观察到的缺陷。它们背后的原则是有出处的:Manny Silva的“文档即测试”立场,即“文档不应只是提供信息;它还应该验证”,以及Write the Docs的Current原则,“认为错误的文档比缺失的文档更糟糕”。参见 ./references/verification-protocol.md 获取完整的冷运行协议。

Friction log

摩擦日志

While cold-running, keep a friction log beside the defect table. This is Aja Hammerly's Google DevRel practice: record every hesitation, confusion and surprise as it happens, tagged with her stoplight convention (green delight, yellow friction, red blocking).
Hesitations are not defects yet. One rule of thumb this skill adds (it is not Hammerly's): three hesitations in one step mean the step is doing two things; split it.
在冷运行时,在缺陷表旁边保留一份摩擦日志。这是Aja Hammerly的Google DevRel实践:记录每一次犹豫、困惑和惊讶,用她的红绿灯约定标记(绿色为愉悦、黄色为摩擦、红色为阻塞)。
犹豫还不是缺陷。这个skill添加的一条经验法则(不是Hammerly的):一个步骤中出现三次犹豫意味着该步骤在做两件事;将其拆分。

KPIs

KPI

Instrument in this order; it is value per hour of wiring, not the order the metrics get reported in:
  • Step-level drop-off: an event per step, an hour of wiring, and it names the step that breaks the run. Every other page metric falls out of the same events.
  • Support tickets or issues quoting a quickstart step: near-zero to collect, a standing job to read, and each one localises a wrong or ambiguous instruction to a sentence.
  • Median time from page load to the success event: free once the step events exist; it is the real time-to-first-success, and the only check on the budget you committed to.
  • Completion rate (readers reaching the success event / readers starting): free once the step events exist; it says the page holds attention and nothing more.
  • Day-7 return of completers: a standing job; docs and product must share an identity, decided before publishing. The only metric that says first success led anywhere.
Median time and completion rate tie on both axes, because they are two readings of the same start-and-success event pair: neither can be bought separately, and neither localises a defect. That order starves the day-7 return, the highest-value metric here and the most expensive. Promote it above everything when completion is healthy and activation is flat; no cheaper metric can tell you whether the success moment was the wrong one.
Set the target from the page's own baseline: measure four weeks as the default period, then commit to a relative improvement; never import a number from a vendor blog.
Guard against regression by running the quickstart's commands verbatim in CI against the published package and asserting the documented output; docs that only inform go stale silently, but docs that also verify fail loudly when the product drifts.
按此顺序进行埋点;它是每小时的布线价值,而不是指标的报告顺序:
  • 步骤级流失:每一步一个事件,一小时的布线,它指出中断运行的步骤。所有其他页面指标都从同一事件中得出。
  • 引用快速入门步骤的支持工单或问题:收集成本几乎为零,但需要持续阅读,每一个都能将错误或模糊的指令定位到一个句子。
  • 从页面加载到成功事件的中位时间:一旦步骤事件存在就免费获得;它是真实的首次成功时间,也是对你承诺预算的唯一检查。
  • 完成率(到达成功事件的读者 / 开始阅读的读者):一旦步骤事件存在就免费获得;它只说明页面能保持注意力,仅此而已。
  • 完成者第7天回访:一项持续工作;文档和产品必须共享一个身份,在发布前决定。这是唯一能说明首次成功带来了后续成果的指标。
中位时间和完成率在两个轴上都并列,因为它们是对同一开始和成功事件对的两种解读:两者都不能单独获得,也都不能定位缺陷。这种顺序会饿死第7天回访,这是这里价值最高也最昂贵的指标。当完成率健康但激活率平稳时,将它提升到一切之上;没有更便宜的指标能告诉你成功时刻是否选错了。
从页面自身的基线设定目标:以四周为默认周期进行测量,然后承诺一个相对改进;绝不从供应商博客引入数字。
通过在CI中针对已发布的包逐字运行快速入门的命令并断言文档输出,来防止回归;只提供信息的文档会悄然过时,但同时也验证的文档会在产品漂移时大声失败。

Ownership

所有权

Put the quickstart in the same repository and pull-request workflow as the product, per Write the Docs' docs-as-code model:
  • "developers will often write a first draft of documentation"
  • a writer reviews it
  • a merge gate blocking PRs without docs "incentivizes developers to write about features while they are fresh"
For a quickstart tied to one SDK or feature, make the shipping engineer the first-draft author; at merge time they alone know the exact commands and output.
Agree on a review cadence and final-authority rule with the team instead of assuming a standard exists.
按照Write the Docs的docs-as-code模型,将快速入门放在与产品相同的仓库和拉取请求工作流中:
  • “开发者通常会写文档的初稿”
  • 由一位写作者审查它
  • 一个在没有文档时阻止PR的合并门“激励开发者在功能还新鲜时写关于它们的文档”
对于与某个SDK或功能绑定的快速入门,让发布工程师担任初稿作者;在合并时,只有他们知道确切的命令和输出。
与团队商定审查节奏和最终权威规则,而不是假设存在标准。

Failure modes

失败模式

SymptomFix
Page opens with background or architecture proseCut to the first action; move concepts to explanation docs
Prerequisite appears at step 3Move it to the prerequisites block with a check command
Reader must pick between three package managersPick one; link the others or use a synchronized switcher
Step has no expected outputAdd observable output, or merge the step into the next one
Step heading is a bare verb ("Connect") or an -ing formRewrite as a complete outcome (the -ing form also translates badly)
Error output shown with no fix pathAdd a one-line fail branch per documented error
Environment setup swells the pageSplit it into its own page, linked from step 1
Quickstart still works only on the author's machineCold run per the pass threshold; automate it in CI
Page grew past the budget over timeRe-cut scope to one success moment; split the rest into how-to guides
Named vendor tools listed as required toolingDescribe the capability, not the vendor; the page outlives the tool
Language tabs added, only one tab ever verifiedCold-run every tab; each is its own quickstart sharing a layout
症状修复
页面以背景或架构散文开头直接切入第一个操作;将概念移到解释文档
前置条件出现在步骤3将其移到带检查命令的前置条件块
读者必须在三个包管理器中选择选一个;链接其他或用同步切换器
步骤没有预期输出添加可观察的输出,或将步骤合并到下一步
步骤标题是裸动词(“Connect”)或_-ing_形式重写为完整结果(_-ing_形式也翻译得很差)
显示错误输出但没有修复路径为每个记录的错误添加一行的失败分支
环境设置使页面膨胀拆分为独立页面,从步骤1链接
快速入门只在作者机器上工作按照通过阈值冷运行;在CI中自动化
页面随时间增长超过预算重新裁剪范围至一个成功时刻;将其他部分拆分为操作指南
将具名供应商工具列为必需工具描述能力而非供应商;页面比工具更长寿
添加了语言标签,但只验证过一个标签冷运行每个标签;每个标签都是共享布局的独立快速入门

Reader-type split

读者类型划分

The artefact is identical for every reader type:
  • Same success moment.
  • Same step shape.
  • Same verification.
What changes is access.
Individual / self-serve reader.
  • Optimize for zero-account or instant-key access.
  • Cover the whole path with a free tier.
  • No billing prompt before success.
Watch for the first example silently requiring a paid feature.
Enterprise / gated reader. The classic defect: a 5-minute code path wrapped in a 3-day access path the page never mentions. Access is the bottleneck, not the code.
  • State upfront what must exist (tenant, sandbox, role, allow-listed network) and who provisions it.
  • Give an offline/on-prem variant of every command that assumes internet.
  • Never write "contact your administrator" without saying what to ask for.
成果物对每种读者类型都是相同的:
  • 相同的成功时刻。
  • 相同的步骤结构。
  • 相同的验证。
改变的是访问方式。
个人 / 自助读者。
  • 优化为零账户或即时密钥访问。
  • 用免费套餐覆盖整个路径。
  • 成功之前不出现计费提示。
注意第一个示例是否暗中要求付费功能。
企业 / 有门控的读者。 经典缺陷:5分钟的代码路径被包裹在页面从未提及的3天访问路径中。访问是瓶颈,而不是代码。
  • 提前说明必须存在什么(租户、沙箱、角色、允许列表网络)以及由谁提供。
  • 为每个假设互联网的命令提供离线/本地部署的变体。
  • 绝不要只写“联系你的管理员”而不说要请求什么。

References

参考资料

  • samber/developer-relations-skills@developer-docs-structure-audit for where content belongs across a docs site.
  • samber/developer-relations-skills@docs-code-sample-standards for sample policy and per-language parity.
  • samber/developer-relations-skills@coding-agent-docs-optimization when the consumer is an agent, not a human.
  • samber/developer-relations-skills@developer-troubleshooting-docs for the error pages the fail branches link to.
  • samber/developer-relations-skills@developer-journey-map for the stage this guide's first-success rate feeds.
  • samber/developer-relations-skills@developer-education-strategy for structured learning beyond a single quickstart's scope.
Named sources behind this skill:
  • Sarah Maddox, "What is a quickstart to you?" (ffeathers, 2018): the audience definition.
  • The Good Docs Project, quickstart and API-quickstart template guides: step, sample and setup rules, and the 1-2 hour bound.
  • Diátaxis (Daniele Procida): the tutorial/how-to split.
  • Write the Docs: documentation principles and the docs-as-code guide.
  • Manny Silva: docs as tests.
  • Aja Hammerly: the friction log.
  • samber/developer-relations-skills@developer-docs-structure-audit 用于内容在文档站点中的归属位置。
  • samber/developer-relations-skills@docs-code-sample-standards 用于示例策略和每种语言的一致性。
  • samber/developer-relations-skills@coding-agent-docs-optimization 当使用者是代理而非人类时。
  • samber/developer-relations-skills@developer-troubleshooting-docs 用于失败分支链接到的错误页面。
  • samber/developer-relations-skills@developer-journey-map 用于本指南的首次成功率所服务的阶段。
  • samber/developer-relations-skills@developer-education-strategy 用于超越单个快速入门范围的结构化学习。
本skill背后的具名来源:
  • Sarah Maddox, "What is a quickstart to you?" (ffeathers, 2018):受众定义。
  • Good Docs Project的快速入门和API快速入门模板指南:步骤、示例和设置规则,以及1-2小时的边界。
  • Diátaxis (Daniele Procida):教程/操作指南的划分。
  • Write the Docs:文档原则和docs-as-code指南。
  • Manny Silva:文档即测试。
  • Aja Hammerly:摩擦日志。