mcpField
Q
quick-start-guide

quick-start-guide

github.com/dengineproblem开发60 次安装
代码仓库

关于 quick-start-guide

quick-start-guide 是用于编写入门文档的技能，帮助用户尽快完成可运行的实现。它围绕前置条件、编号步骤、验证、故障排查和后续步骤组织指南。

主要功能

  1. 01快速入门指南模板
  2. 02逐步展开概念
  3. 03提供各步骤的预期结果
  4. 04验证与故障排查指引
  5. 05按平台调整内容

适用场景

  1. 01编写产品上手文档
  2. 02记录首次可运行实现的步骤
  3. 03为设置步骤补充验证和解决办法

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/dengineproblem/agents-monorepo --skill quick-start-guide

安装后在 Claude Code 中输入/quick-start-guide确认已加载。

详细介绍

快速入门指南创建者

擅长创建有效的入门文档，帮助用户在 5-15 分钟内实现可正常运行的方案。

核心原则

优化价值实现时间
  • 先展示令人印象深刻的功能，而不是设置步骤
  • 通过早期成果立即带来价值
  • 将高级概念留给后续文档介绍
  • 目标是在 5-15 分钟内完成
渐进式披露
  • 先清晰列出前置条件
  • 使用编号步骤
  • 逐步增加复杂度
  • 链接到更深入的文档

快速入门模板

# Quick Start: [Product Name]

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

## Prerequisites

Before starting, ensure you have:
- [ ] Node.js 18+ installed
- [ ] API key from [link to get key]
- [ ] Basic familiarity with [technology]

## Step 1: Install

```bash
npm install @company/product

预期输出：

added 42 packages in 3s

第 2 步：配置

在项目根目录中创建 config.js：

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

第 3 步：执行你的第一个 [操作]

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

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

运行：

API_KEY=your_key node index.js

预期输出：

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

验证是否正常工作

你应该能看到：

  • ✅ 控制台中没有错误
  • ✅ 状态正常的成功响应
  • ✅ [具体验证内容]

故障排除

“API 密钥无效”错误
  • 在 [仪表板链接] 中验证你的密钥
  • 确保密钥中没有多余空格
  • 检查密钥权限
“找不到模块”错误
  • 再次运行 npm install
  • 验证 Node.js 版本：node --version

后续步骤

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


## 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"

由验证驱动的结构

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"

平台适配

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"

最佳实践

  1. 测试每个步骤 — 每个步骤都必须经过验证
  2. 展示预期输出 — 用户应该知道自己会看到什么
  3. 提供一条成功路径 — 不要让用户选择，直接给出建议
  4. 故障排除部分 — 涵盖常见错误
  5. 明确后续步骤 — 引导用户找到后续资源
  6. 保持简短 — 最多 5-15 分钟

评论

支持 Markdown