Claude Skill

vllm-feature-tutorial

Generate comprehensive Chinese technical tutorial documents for vLLM features and modules. Produces deep-dive code walkthrough documents with Mermaid architecture/flow diagrams, comparison tables, code snippets, and performance analysis. Output is saved as Markdown to the skill's

LLM Mart · 0 points · 1 views 0 listing impressions 0 install-command copies
Download shen-shanshan-vllm-dev-skills-skills_vllm-feature-tutorial-f687af6.zip · 287 KB

Install

skills CLI npx skills add https://github.com/shen-shanshan/vllm-dev-skills/tree/master/skills/vllm-feature-tutorial
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install shen-shanshan-vllm-dev-skills@llmmart
Git git clone https://github.com/shen-shanshan/vllm-dev-skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole shen-shanshan/vllm-dev-skills collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

vLLM Feature Tutorial Generator

Generate a comprehensive code walkthrough tutorial document for a given vLLM feature or module.

Workflow

Step 1: Identify the Feature

Extract the feature/module name from the user's request. Examples:

  • "spec decode" / "speculative decoding"
  • "chunked prefill"
  • "automatic prefix caching"
  • "tensor parallelism"
  • "KV cache management"
  • "continuous batching"
  • "LoRA"
  • "multimodal"

Step 2: Research the Feature

Gather information from multiple sources. This is the most important step — thorough research determines document quality.

2a. vLLM Official Documentation

  • Fetch relevant pages from https://docs.vllm.ai/en/latest/ using WebFetch
  • Look for design docs, API references, usage guides

2b. vLLM Source Code

  • Use gh api or WebFetch to browse the vLLM GitHub repo (vllm-project/vllm)
  • Identify core source files for the feature (use GitHub code search or browse directory structure)
  • Read key implementation files to understand:
    • Core classes and their responsibilities
    • Key interfaces and method signatures
    • Data flow and control flow
    • Important algorithms and data structures

2c. Related Resources

  • Search for relevant blog posts, papers, or design documents
  • Check vLLM GitHub discussions/issues for design rationale

Step 3: Generate the Tutorial Document

Read references/style-guide.md for the complete document structure and formatting conventions.

Key requirements:

  • Write in Chinese (简体中文), keeping English for technical terms
  • Follow the multi-part structure defined in the style guide
  • Include rich visual elements:
    • Mermaid flowcharts for workflows and data flow
    • Mermaid architecture diagrams (flowchart TB with subgraph) for system overview
    • Mermaid sequence diagrams for component interactions
    • Mermaid class diagrams for class hierarchies
    • Tables for parameter references, method comparisons, performance metrics
    • Code snippets with file path annotations from actual vLLM source
    • LaTeX formulas for algorithm analysis (where applicable)
  • Include a document header with version info and date
  • Include a 文档概述 section with target audience and reading guide
  • End with appendices: code location index and glossary

Step 4: Save Output

Save the generated markdown file to outputs/ directory relative to this skill's location:

  • File path: outputs/{feature_name}.md (e.g., outputs/spec_decode.md, outputs/chunked_prefill.md)
  • Create the outputs/ directory if it doesn't exist
  • Use snake_case for file names

The skill directory is located at the same directory as this SKILL.md file.

Content Depth Guidelines

  • Part 1 (Basics & Architecture): Start from first principles. Explain the "what" and "why". Include theoretical analysis with formulas if the feature involves algorithms. Provide architecture overview with Mermaid diagrams.
  • Part 2 (Core Interfaces): Analyze base classes, interfaces, factory methods. Include class diagrams and method signatures.
  • Part 3 (Deep Implementation): Walk through actual vLLM code. Include code snippets with annotations. Trace execution flow with concrete examples.
  • Part 4+ (Variants/Comparisons): If the feature has multiple implementations or methods, compare them in tables.
  • Final Part (Configuration): Provide practical usage guidance, key parameters, tuning tips.
  • Appendix: Code location index table mapping components to file paths.

Quality Checklist

Before saving the document, verify:

  • Document has 3+ Mermaid diagrams (architecture, flow, sequence/class)
  • Document has 3+ comparison/reference tables
  • Document includes actual code snippets from vLLM source with file path annotations
  • Document follows the Chinese writing convention with English technical terms
  • All sections have substantive content (no placeholder text)
  • Document header includes version and date metadata

References

Files (vllm-dev-skills)
  • outputs
    • amd_aiter_in_vllm.md 33.1 KB
      Loading…
    • atom_prefill_delayer.md 42.1 KB
      Loading…
    • breakable_cudagraph.md 26 KB
      Loading…
    • dcp.md 62.5 KB
      Loading…
    • deepseek_v4_kv_cache_multistream.md 29.5 KB
      Loading…
    • disaggregated_encoder_epd.md 36.5 KB
      Loading…
    • dspark.md 76.6 KB
      Loading…
    • dual_batch_overlap.md 49.3 KB
      Loading…
    • fast_start.md 62.4 KB
      Loading…
    • jit_kernel_warmup.md 38.4 KB
      Loading…
    • model_runner_v2.md 27.4 KB
      Loading…
    • multi_stream_overlap.md 23.7 KB
      Loading…
    • prefill_dbo.md 37.9 KB
      Loading…
    • umbp_store_connector.md 63.3 KB
      Loading…
    • vit_full_cuda_graph.md 86.5 KB
      Loading…
    • workspace_manager.md 33.7 KB
      Loading…
  • references
    • style-guide.md 3.4 KB
      Loading…
  • SKILL.md 4.8 KB
    ---
    name: vllm-feature-tutorial
    description: >
      Generate comprehensive Chinese technical tutorial documents for vLLM features and modules.
      Produces deep-dive code walkthrough documents with Mermaid architecture/flow diagrams, comparison tables,
      code snippets, and performance analysis. Output is saved as Markdown to the skill's outputs/ directory.
      TRIGGER when: user asks to learn about a vLLM feature, module, or subsystem (e.g., "我想了解 vllm 中的 xxx",
      "帮我生成 vllm xxx 的教程", "generate a tutorial for vllm's xxx feature", "vllm xxx 特性分析").
      DO NOT TRIGGER when: user asks about non-vLLM projects, or asks for simple Q&A without requesting a tutorial document.
    ---
    
    # vLLM Feature Tutorial Generator
    
    Generate a comprehensive code walkthrough tutorial document for a given vLLM feature or module.
    
    ## Workflow
    
    ### Step 1: Identify the Feature
    
    Extract the feature/module name from the user's request. Examples:
    - "spec decode" / "speculative decoding"
    - "chunked prefill"
    - "automatic prefix caching"
    - "tensor parallelism"
    - "KV cache management"
    - "continuous batching"
    - "LoRA"
    - "multimodal"
    
    ### Step 2: Research the Feature
    
    Gather information from multiple sources. This is the most important step — thorough research determines document quality.
    
    **2a. vLLM Official Documentation**
    - Fetch relevant pages from `https://docs.vllm.ai/en/latest/` using WebFetch
    - Look for design docs, API references, usage guides
    
    **2b. vLLM Source Code**
    - Use `gh api` or WebFetch to browse the vLLM GitHub repo (`vllm-project/vllm`)
    - Identify core source files for the feature (use GitHub code search or browse directory structure)
    - Read key implementation files to understand:
      - Core classes and their responsibilities
      - Key interfaces and method signatures
      - Data flow and control flow
      - Important algorithms and data structures
    
    **2c. Related Resources**
    - Search for relevant blog posts, papers, or design documents
    - Check vLLM GitHub discussions/issues for design rationale
    
    ### Step 3: Generate the Tutorial Document
    
    Read [references/style-guide.md](references/style-guide.md) for the complete document structure and formatting conventions.
    
    Key requirements:
    - Write in **Chinese (简体中文)**, keeping English for technical terms
    - Follow the multi-part structure defined in the style guide
    - Include rich visual elements:
      - **Mermaid flowcharts** for workflows and data flow
      - **Mermaid architecture diagrams** (flowchart TB with subgraph) for system overview
      - **Mermaid sequence diagrams** for component interactions
      - **Mermaid class diagrams** for class hierarchies
      - **Tables** for parameter references, method comparisons, performance metrics
      - **Code snippets** with file path annotations from actual vLLM source
      - **LaTeX formulas** for algorithm analysis (where applicable)
    - Include a document header with version info and date
    - Include a 文档概述 section with target audience and reading guide
    - End with appendices: code location index and glossary
    
    ### Step 4: Save Output
    
    Save the generated markdown file to `outputs/` directory relative to this skill's location:
    - File path: `outputs/{feature_name}.md` (e.g., `outputs/spec_decode.md`, `outputs/chunked_prefill.md`)
    - Create the `outputs/` directory if it doesn't exist
    - Use snake_case for file names
    
    The skill directory is located at the same directory as this SKILL.md file.
    
    ## Content Depth Guidelines
    
    - **Part 1 (Basics & Architecture)**: Start from first principles. Explain the "what" and "why". Include theoretical analysis with formulas if the feature involves algorithms. Provide architecture overview with Mermaid diagrams.
    - **Part 2 (Core Interfaces)**: Analyze base classes, interfaces, factory methods. Include class diagrams and method signatures.
    - **Part 3 (Deep Implementation)**: Walk through actual vLLM code. Include code snippets with annotations. Trace execution flow with concrete examples.
    - **Part 4+ (Variants/Comparisons)**: If the feature has multiple implementations or methods, compare them in tables.
    - **Final Part (Configuration)**: Provide practical usage guidance, key parameters, tuning tips.
    - **Appendix**: Code location index table mapping components to file paths.
    
    ## Quality Checklist
    
    Before saving the document, verify:
    - [ ] Document has 3+ Mermaid diagrams (architecture, flow, sequence/class)
    - [ ] Document has 3+ comparison/reference tables
    - [ ] Document includes actual code snippets from vLLM source with file path annotations
    - [ ] Document follows the Chinese writing convention with English technical terms
    - [ ] All sections have substantive content (no placeholder text)
    - [ ] Document header includes version and date metadata
    
    ## References
    
    - [references/style-guide.md](references/style-guide.md) — Document structure, formatting conventions, and content patterns
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.