arda/skills
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refine teaching skill documentation to enhance clarity and interactivity of explainers

Browse source
This commit is contained in:
Matt Pocock 2026-05-31 10:08:36 +01:00
parent e3b90b5238
commit aaf2453fbd
2 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
skills/engineering/to-prd/SKILL.md
View file

@ -11,11 +11,9 @@ The issue tracker and triage label vocabulary should have been provided to you
1. Explore the repo to understand the current state of the codebase, if you haven't already. Use the project's domain glossary vocabulary throughout the PRD, and respect any ADRs in the area you're touching. 1. Explore the repo to understand the current state of the codebase, if you haven't already. Use the project's domain glossary vocabulary throughout the PRD, and respect any ADRs in the area you're touching.
2. Sketch out the major modules you will need to build or modify to complete the implementation. Actively look for opportunities to extract deep modules that can be tested in isolation. 2. Sketch out the seams at which you're going to test the feature. Existing seams should be preferred to new ones. Use the highest seam possible. If new seams are needed, propose them at the highest point you can.
A deep module (as opposed to a shallow module) is one which encapsulates a lot of functionality in a simple, testable interface which rarely changes. Check with the user that these seams match their expectations.
Check with the user that these modules match their expectations. Check with the user which modules they want tests written for.
3. Write the PRD using the template below, then publish it to the project issue tracker. Apply the `ready-for-agent` triage label - no need for additional triage. 3. Write the PRD using the template below, then publish it to the project issue tracker. Apply the `ready-for-agent` triage label - no need for additional triage.

4
skills/in-progress/teach/SKILL.md
View file

@ -60,6 +60,10 @@ Knowledge and skills usually need to be taught as a 1-2 punch. You teach the kno
Knowledge should first be gathered from trusted resources, then taught to the user via HTML explainers. These explainers should be beautiful, adhere to the glossary, and be saved to the local file system where they can be reviewed later. Knowledge should first be gathered from trusted resources, then taught to the user via HTML explainers. These explainers should be beautiful, adhere to the glossary, and be saved to the local file system where they can be reviewed later.
Explainers should be littered with citations - links to external resources to back up any claim made.
Explainers should be as interactive as possible, with "try this" callouts to let the user try the knowledge.
You should make opening the HTML explainer as easy as possible for the user, ideally with a CLI command they can run. You should make opening the HTML explainer as easy as possible for the user, ideally with a CLI command they can run.
Once the user has read the knowledge, allow them to ask questions about it. Answer their questions directly, and amend the explainer if needed (or produce another one). Once the user has read the knowledge, allow them to ask questions about it. Answer their questions directly, and amend the explainer if needed (or produce another one).