Getting Started with the Skill

How to provide a codebase and launch the automatic course generation

On this page

01Providing Your Project 02The Two Required Questions 03What Happens Next 04Tips for Best Results

01

Providing Your Project

The first step: tell the skill which code to analyze. There are three ways to do this, and the skill auto-detects which one you're using.

📁

Local Folder

Provide a path on your machine. The skill reads all relevant files in the directory.

/Users/my-name/projects/my-tool

🔗

GitHub URL

Share a GitHub repository URL. The skill clones the repo and analyzes the code.

github.com/org/my-project

📂

Current Project

If you launch the skill inside a project folder, just say "use the current project".

"Use this project right here"

Good to know: The skill doesn't require a specific command. Just write naturally what you want — e.g. "Create a learning course for /Users/max/my-tool" or "Analyze https://github.com/org/project". Detection happens automatically.

02

The Two Required Questions

Before generating a single line of HTML, the skill asks two questions. There are no defaults — both must be answered. This is intentional, because the answers determine everything that follows.

Skill

Which target audiences should receive a course?

Select one or more:
👤 End Users — people who use the software
🔧 Developers — technical contributors
📊 Decision Makers — managers & stakeholders
🏷️ Custom — define your own audience

You

End Users and Developers

Skill

How will the HTML files be used?

Standalone — for sharing via email/Slack
Embedded — part of a website (with legal notice, GitHub link, navigation)

You

Embedded

Skill

Got it. Please provide the URLs for:
• GitHub repository
• Legal notice / Impressum page

Then I'll get started.

🎯

Question 1: Audiences

Multi-select from the available audiences. Each selected group gets its own complete course with separate HTML files.

Required

📄

Question 2: Integration Mode

Standalone: Files for sharing, no framing. Embedded: With header, footer, legal notice and links — ready for a website.

Required

03

What Happens Next

Once you've answered both questions, the skill kicks off a seven-phase process. You don't need to do anything else — the skill works through each phase automatically and produces finished HTML files at the end.

1

Analyze Codebase The skill reads all relevant files, identifies languages, frameworks, and architecture.

2

Plan Curriculum A curriculum is created per audience: which topics, in what order, at which depth level.

3

Calculate Helpfulness Scores For each topic, the skill evaluates whether a deep-dive page would be useful for the given audience (score 1-10).

4

Generate Overview Pages The main pages (one per audience, DE + EN each) are created — with all modules and visualizations.

5

Generate Deep-Dive Pages Topics with high Helpfulness Scores get their own pages with more detail, examples, and quizzes.

6

Generate Detail Pages For particularly deep topics (especially for developers), additional levels with code walkthroughs are created.

7

Linking and Finalization All pages are linked together, language versions connected, and the final file structure placed in the output folder.

04

Tips for Best Results

📂

Provide All Files

Give the skill access to all relevant files. The more context, the better the explanations. Config files, README, tests — everything helps.

👥

Name All Audiences Upfront

Declare all target audiences at the start. Adding audiences later means curricula and scores need to be recalculated from scratch.

🔗

Have URLs Ready for Embedded Mode

If you choose "Embedded", have your URLs ready: GitHub repository, legal notice page, and any additional navigation links.

⚡

Be Patient with Large Projects

For extensive codebases, generation can take several minutes. The skill works thoroughly — quality takes time.

✏️ Quick Check

What's the minimum the skill needs to get started?

Just the path to the code — the skill decides the rest

Code source + target audiences + integration mode

Code source + target audiences + integration mode + an outline

Just the audiences — the skill finds the code itself

More deep-dive pages for End Users

01 Getting Started 02 Audiences & Integration 03 The Level System 04 Depth Profiles