Skip to content

Commit 77afa6c

Browse files
committed
docs: restructure infos about Guided Learning skills
Signed-off-by: Kenny Pflug <[email protected]>
1 parent d9ab04a commit 77afa6c

1 file changed

Lines changed: 10 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,23 @@ The full method is documented at
2121
| `guided-coding-review-plan` | Review a plan draft against the repository (use in fresh conversation). |
2222
| `guided-coding-freeze-plan` | Freeze a plan by timestamping its file name and title. |
2323
| `guided-coding-implement` | Implement a frozen plan and verify it through the repository's feedback loops. |
24-
| `guided-coding-implement-show-me` | Implement a frozen plan through worked code examples that you enter and discuss. |
25-
| `guided-coding-implement-coach-me` | Implement a frozen plan yourself through coached, verifiable milestones. |
24+
| `guided-coding-implement-show-me` | (Guided Learning) Implement a frozen plan step-by-step where the agent shows you complete code fragments that you enter and discuss. |
25+
| `guided-coding-implement-coach-me` | (Guided Learning) Implement a frozen plan yourself through coached, verifiable milestones. The agent reveals implementation hints progressively. |
2626
| `guided-coding-write-deviations` | Summarize follow-up plans and record material implementation differences. |
2727

28-
All workflows require explicit user invocation.
28+
In most Agent Harnesses, these workflows must be invoked explicitly. All workflows set `allow_implicit_invocation: false` for Agent Plugins and `disable-model-invocation: true` for Claude Plugins, respectively.
2929

3030
## Guided Learning
3131

32-
With `guided-coding-implement-show-me` and `guided-coding-implement-coach-me`, you implement a
33-
frozen plan yourself while the agent teaches you. Pick the skill that matches your stage in the
34-
plan's domain:
32+
Guided Learning is a variation of Guided Coding where the agent does not implement the plan itself but teaches you how to implement it. The `guided-coding-implement-show-me` and `guided-coding-implement-coach-me` skills give you two approaches for Beginning and Advanced developers that want to increase their capabilities. The regular `guided-coding-implement` skill should be used for regular Guided Coding.
3533

3634
| Stage | Skill | How the agent teaches |
3735
| --- | --- | --- |
38-
| **Beginning**: new to the domain, learning its fundamental concepts | `guided-coding-implement-show-me` | Splits the plan into layers and presents complete code, fragment by fragment, for you to type and discuss. |
39-
| **Advancing**: fluent in the fundamentals, adapting them to new problems | `guided-coding-implement-coach-me` | Splits the plan into vertical slices that you implement yourself, reviews your work, and reveals hints progressively. |
40-
| **Mastering**: questioning and replacing the fundamentals themselves | `guided-coding-implement` | Implements the plan while you guide it. |
36+
| **Beginning** | `guided-coding-implement-show-me` | Splits the plan into layers and presents complete code, fragment by fragment, for you to type and discuss. This is useful when you are new to a topic and want to quickly learn the fundamental concepts. The agent is always ready for your questions. |
37+
| **Advancing** | `guided-coding-implement-coach-me` | Splits the plan into vertical slices that you implement yourself, reviews your work, and reveals hints progressively. This is useful when you are proficient at a topic and want more of a challenge to master your skills. |
38+
| **Mastering** | `guided-coding-implement` | Regular Guided Coding: the Coding Agent implements the plan for you. No teaching involved. |
4139

42-
Both skills track your progress in `~/.guided-learning/profile.md`: your preferences for how to be
43-
taught and a tree of knowledge areas, each at one of the three stages. On first use, the agent
44-
creates this folder as a local git repository (Git 2.28 or later), commits every update with a
45-
message stating what it observed, and never pushes. The profile never ends up in your project
46-
repository, and you can edit or delete it at any time.
40+
Both skills track your progress in `~/.guided-learning/profile.md`: this file contains your preferences for how to be taught and a tree of knowledge areas, each at one of the three stages. On first use, the agent creates this folder as a local git repository (requires Git 2.28 or later) and commits every update locally with a message stating what it observed. This repo is never pushed by default, but you could share it across different machines. We recommend pushing to a private repository. The profile never ends up in your project repository, and you can edit or delete it at any time.
4741

4842
## Install
4943

@@ -56,7 +50,7 @@ gh skill install feO2x/guided-coding --all --agent universal --scope project
5650
```
5751

5852
Install one skill by naming it, or add `--scope user` to make the installation available across
59-
repositories. GitHub CLI's skill commands are currently in preview.
53+
repositories.
6054

6155
If you want to update, use the following command:
6256

@@ -85,7 +79,7 @@ claude plugin marketplace update guided-coding
8579
claude plugin update guided-coding@guided-coding --scope project
8680
```
8781

88-
Restart Claude Code afterwards. Only then will the updated skills be picked up.
82+
> ⚠️ Restart Claude Code afterwards. Only then will the updated skills be picked up.
8983
9084
### Agent Plugin clients
9185

0 commit comments

Comments
 (0)