learning-a-tool

Learning a Tool

Create comprehensive learning paths for programming tools.

Workflow

Phase 1: Research

Gather information from three sources. Research each source independently, then aggregate findings.

From Official Documentation

• Official docs URL and current version
• The motivation behind the tool
• What problem does it solve / what does it help with
• What types of applications can be built using the tool
• Use cases
• Installation steps and prerequisites
• Core concepts (3-5 fundamental ideas)
• Official code examples
• Getting started or tutorial content
• API reference highlights
• Known limitations or caveats

From the Repository

• Repository URL and metadata (stars, last commit, license)
• Core system architecture (configuration, data processing flow, ...)
• README quick start section
• Examples folder contents (what each example demonstrates)
• Concise summary of the project's main function and the technologies used

From Community Content

• Top tutorials (title, author, URL, why it's valuable)
• Video resources (title, channel, duration)
• Comparison articles (vs alternatives, key tradeoffs)
• Common gotchas and mistakes people mention
• Community channels (Discord, Reddit, forums)
• Real-world use cases and testimonials

Phase 2: Structure

Organize content into progressive levels. references/progressive-learning.md is the source of truth.

You MUST create exactly 5 levels in this order:

1. Level 1: Overview & Motivation
2. Level 2: Installation & Hello World
3. Level 3: Core Concepts
4. Level 4: Practical Patterns
5. Level 5: Next Steps

Do NOT merge, skip, or rename levels. Each level's content requirements are defined in the reference file.

Phase 3: Output

Generate the learning path folder.

Output Format

Create the folder in the current working directory (./learning-{tool-name}/) containing:

learning-{tool-name}/
├── README.md           # Overview and how to use this learning path
├── resources.md        # All links organized by source (official, community)
├── learning-path.md    # Main content following the five levels
└── code-examples/      # Runnable code for each section
    ├── 01-hello-world/
    ├── 02-core-concepts/
    └── 03-patterns/