quick-start-guide

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Quick Start Guide Creator

快速入门指南创建工具

Expert in creating effective onboarding documentation that helps users achieve working implementations in 5-15 minutes.

擅长创建高效的新用户入职文档，帮助用户在5-15分钟内完成可运行的功能实现。

Core Principles

核心原则

Time-to-Value Optimization

价值交付时间优化

Lead with impressive features, not setup
Deliver immediate value through early wins
Defer advanced concepts to later documentation
Target completion in 5-15 minutes

优先展示亮眼功能，而非设置步骤
通过早期成功交付即时价值
将高级概念延后至后续文档介绍
目标完成时长：5-15分钟

Progressive Disclosure

渐进式信息披露

Start with clear prerequisites
Use numbered steps
Build complexity gradually
Link to deeper documentation

从明确的前置条件开始
使用编号步骤
逐步提升复杂度
链接至深度文档

Quick Start Template

快速入门模板

markdown

undefined

markdown

undefined

Quick Start: [Product Name]

快速入门：[产品名称]

Get [product] running in 5 minutes. By the end, you'll have [specific outcome].

在5分钟内让[产品]运行起来。完成后，你将实现[具体成果]。

Prerequisites

前置条件

Before starting, ensure you have:

Node.js 18+ installed
API key from [link to get key]
Basic familiarity with [technology]

开始前，请确保你已具备：

安装Node.js 18+
从[获取密钥链接]获取API密钥
对[相关技术]有基础了解

Step 1: Install

步骤1：安装

bash

npm install @company/product

Expected output:

added 42 packages in 3s

bash

npm install @company/product

预期输出：

added 42 packages in 3s

Step 2: Configure

步骤2：配置

Create

config.js

in your project root:

javascript

// config.js
module.exports = {
  apiKey: process.env.API_KEY,
  environment: 'development'
};

在项目根目录创建

config.js

文件：

javascript

// config.js
module.exports = {
  apiKey: process.env.API_KEY,
  environment: 'development'
};

Step 3: Run Your First [Action]

步骤3：运行首个[操作]

javascript

// index.js
const product = require('@company/product');
const config = require('./config');

const client = product.init(config);
const result = await client.doSomething();
console.log(result);

Run it:

bash

API_KEY=your_key node index.js

Expected output:

json

{
  "status": "success",
  "message": "Hello from Product!"
}

javascript

// index.js
const product = require('@company/product');
const config = require('./config');

const client = product.init(config);
const result = await client.doSomething();
console.log(result);

运行命令：

bash

API_KEY=your_key node index.js

预期输出：

json

{
  "status": "success",
  "message": "Hello from Product!"
}

Verify It Works

验证运行状态

You should see:

✅ No errors in console
✅ Success response with status
✅ [Specific verification]

你应该看到：

✅ 控制台无错误
✅ 返回包含状态的成功响应
✅ [具体验证项]

Troubleshooting

故障排查

"API key invalid" error

“API密钥无效”错误

Verify your key at [dashboard link]
Ensure no extra spaces in the key
Check key permissions

在[控制台链接]验证你的密钥
确保密钥无多余空格
检查密钥权限

"Module not found" error

“模块未找到”错误

Run
```
npm install
```
again
Verify Node.js version:
```
node --version
```

重新运行
```
npm install
```
验证Node.js版本：
```
node --version
```

Next Steps

后续步骤

Now that you have [product] running:

📖 Full Configuration Guide
🔧 API Reference
💡 Example Projects
💬 Community Discord

undefined

现在你已成功运行[产品]：

📖 完整配置指南
🔧 API参考文档
💡 示例项目
💬 社区Discord

undefined

Writing Standards

写作规范

yaml

writing_guidelines:
  voice: "Active voice, imperative mood"
  reading_level: "8th grade"
  sentence_length: "Under 20 words"
  address: "Direct 'you' to reader"

  examples:
    good: "Run this command to install dependencies."
    bad: "Dependencies should be installed by running..."

code_examples:
  requirements:
    - "Complete and runnable"
    - "Show actual file paths"
    - "Include all imports"
    - "Use realistic values"

  structure:
    - "File name as comment"
    - "Necessary imports first"
    - "Configuration second"
    - "Action code last"

anti_patterns:
  avoid:
    - "Information overload"
    - "Vague instructions like 'configure your environment'"
    - "Missing file locations"
    - "Assuming knowledge"
    - "Multiple options without recommendation"

yaml

writing_guidelines:
  voice: "主动语态、祈使语气"
  reading_level: "8年级阅读水平"
  sentence_length: "少于20个单词"
  address: "直接以‘你’称呼读者"

  examples:
    good: "运行此命令安装依赖。"
    bad: "依赖应通过运行...来安装"

code_examples:
  requirements:
    - "完整且可运行"
    - "展示实际文件路径"
    - "包含所有导入语句"
    - "使用真实可信的值"

  structure:
    - "文件名作为注释"
    - "必要的导入语句优先"
    - "配置部分其次"
    - "业务代码最后"

anti_patterns:
  avoid:
    - "信息过载"
    - "模糊指令如‘配置你的环境’"
    - "缺失文件位置"
    - "假设读者具备相关知识"
    - "提供多个选项却无推荐"

Validation-Driven Structure

验证驱动的结构

yaml

validation_points:
  after_each_step:
    - "Expected output with example"
    - "What success looks like"
    - "Common error and fix"

  success_criteria:
    - "80% of users complete successfully"
    - "Working output on first attempt"
    - "Under 15 minutes total"

verification_checklist:
  - "[ ] All code blocks tested"
  - "[ ] Expected outputs accurate"
  - "[ ] Links working"
  - "[ ] Prerequisites complete"
  - "[ ] Troubleshooting covers common issues"

yaml

validation_points:
  after_each_step:
    - "带示例的预期输出"
    - "成功的表现形式"
    - "常见错误及修复方案"

  success_criteria:
    - "80%的用户可成功完成"
    - "首次尝试即可得到可运行输出"
    - "总耗时不超过15分钟"

verification_checklist:
  - "[ ] 所有代码块均经过测试"
  - "[ ] 预期输出准确"
  - "[ ] 链接可正常访问"
  - "[ ] 前置条件完整"
  - "[ ] 故障排查覆盖常见问题"

Platform Adaptations

平台适配

yaml

platform_variations:
  installation:
    macos: "brew install product"
    linux: "apt-get install product"
    windows: "choco install product"

  paths:
    macos: "~/Library/Application Support/Product"
    linux: "~/.config/product"
    windows: "%APPDATA%\\Product"

  commands:
    unix: "export API_KEY=your_key"
    windows: "set API_KEY=your_key"

yaml

platform_variations:
  installation:
    macos: "brew install product"
    linux: "apt-get install product"
    windows: "choco install product"

  paths:
    macos: "~/Library/Application Support/Product"
    linux: "~/.config/product"
    windows: "%APPDATA%\\Product"

  commands:
    unix: "export API_KEY=your_key"
    windows: "set API_KEY=your_key"

Лучшие практики

最佳实践

Test every step — каждый шаг должен быть проверен
Show expected output — пользователь должен знать что увидит
One path to success — не давайте выбор, давайте рекомендацию
Troubleshooting section — покройте частые ошибки
Clear next steps — направьте к следующим ресурсам
Keep it short — 5-15 минут максимум

测试每一个步骤——每个步骤都必须经过验证
展示预期输出——用户需要知道会看到什么
唯一成功路径——不要给用户选择，直接给出推荐方案
故障排查板块——覆盖常见错误
清晰的后续步骤——引导用户查看后续资源
保持精简——最多5-15分钟