Skip to content

Commit 80dae6a

Browse files
authored
Revise skill development process documentation
Updated the process documentation for skill development, including changes to function names and validation steps.
1 parent eb7314b commit 80dae6a

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

ai/skills/aidd-upskill/references/process.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,50 +20,54 @@ createSkill(userRequest) {
2020
## Steps
2121

2222
**gatherRequirements(userRequest)**
23-
1. discoverRelatedSkills — search `$projectRoot/ai/` and `$projectRoot/aidd-custom/` for SKILL.md, `.mdc`, `.md` files; read frontmatter descriptions; identify overlap or complementary skills
23+
1. discoverRelatedSkills — search the project for SKILL.md, `.mdc`, `.md` files; read frontmatter descriptions; identify overlap or complementary skills
2424
2. researchBestPractices — use web search to find best practices for the domain; summarize findings
2525
3. Infer requirements from the above context. Do not ask clarifying questions or block on user input. Use a judge to evaluate completeness: yes → proceed; no → state gaps as explicit assumptions and proceed.
2626

27-
Infer answers to these questions from context rather than asking the user:
27+
Infer answers to these questions from context:
2828
- What problem does this skill solve?
2929
- What are its inputs and outputs?
3030
- Any technical constraints or requirements?
3131
- Should it `alwaysApply`? (recommend yes only if it applies to nearly every task)
3232

3333
**nameSkill(topic)**
34-
- Use verb or role-based noun form (e.g., `aidd-format-code`, `aidd-upskill`)
35-
- Validate against `SkillName` type constraints
34+
- Use verb or role-based noun form (e.g., `format-code`, `upskill`)
3635

3736
**buildPlan() => SkillPlan**
38-
Produce a `SkillPlan` struct (see `references/types.md`).
37+
Produce a `SkillPlan`
3938

4039
**presentPlan(plan: SkillPlan)**
4140
Show the full plan, then run a self-validating quality gate — do not await user approval:
42-
1. Run `/aidd-review` on the plan
43-
2. Issues found => run `/aidd-fix` loop until all issues are resolved
44-
3. Proceed to `draftSkillMd`
41+
42+
While important issues remain {
43+
reviewPlan |> fix
44+
}
4545

4646
**draftSkillMd(plan: SkillPlan)**
4747
- Write frontmatter: `name` + `description` required; add `metadata.alwaysApply` if needed
4848
- Write body with all `RequiredSections`
4949
- If body will exceed the line threshold (run `validate-skill` to check), extract content to `references/` and use `import $referenceFile`
5050

5151
**writeSkill(skillMd)**
52-
- Write to `$projectRoot/aidd-custom/skills/${skillName}/SKILL.md`
53-
- Create `scripts/`, `references/`, or `assets/` directories only if planned
52+
- Write to `$skillHome/${skillName}/SKILL.md`
53+
- Create `scripts/`, `references/`, or `assets/` directories as required
5454

5555
**writeReadme(skillMd)**
5656
- Write `README.md` in the skill directory
5757
- Include: what the skill is, why it is useful, command reference with usage examples
5858
- Exclude: implementation details, process narratives, pipeline descriptions
59+
- Avoid tables
60+
5961

6062
**validate**
6163
```bash
62-
ai/skills/aidd-upskill/scripts/validate-skill ./path-to-skill-directory
64+
/validate-skill ./path-to-skill-directory
6365
# If skills-ref is available:
6466
skills-ref validate ./path-to-skill-directory
6567
```
6668

69+
If CLI access is unavailable, carefully emulate the validation process.
70+
6771
**reportMetrics**
6872
Report `SizeMetrics` and any threshold warnings to the user.
6973

0 commit comments

Comments
 (0)