Skip to content

Commit 215fd10

Browse files
authored
Merge pull request #3459 from anupras-mohapatra-arm/fixes
Adding a short blurb to contributor LP about using skills for style compliance + tweaking a skill
2 parents 4aae874 + 2a6ce7d commit 215fd10

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

.github/skills/learning-path-structure-review/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Use this skill when a Learning Path needs a structural review. Focus on whether
1717
- Additional resources and next steps live in `_index.md` `further_reading`, not in `_next-steps.md`.
1818
- `_next-steps.md` remains minimal and respects `FIXED, DO NOT MODIFY` template comments.
1919
4. Review the instructional shape:
20-
- The title and opening frame one developer task.
20+
- The title and opening of the Learning Path frame one developer task/job-to-be-done.
2121
- The introduction gives context, user goal, and practical value.
2222
- Prerequisites are explicit and linked when useful.
2323
- Learning objectives are measurable, action-oriented, and limited to three or four bullets.
24-
- Sections progress logically through prepare, configure, use, and validate phases.
24+
- Sections progress logically through prepare, configure, use, and validate phases, with each section ideally focusing on one job-to-be-done. Flag nebulous sections with titles such as "working with x" or "managing y" that include multiple tasks that shouldn't be grouped together (e.g. creating and deleting a VM, or creating a VM and security group rules in the same section).
2525
- Validation steps prove the learner reached the promised outcome.
2626
- The conclusion or next-step guidance names what the learner can do next.
2727
5. Review `further_reading`:

content/learning-paths/cross-platform/_example-learning-path/appendix-2-writing-style.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,28 @@ Learning Paths are intended for software developers with differing experience le
193193

194194
| Software Development Areas | Skills |
195195
|------------------------------------- |----------|
196-
| Embedded and Microcontroller | Understanding of programming languages such as C, C++ and assembly. Basic awareness of Linux OS, RTOSes. Fundamental knowledge of hardware and software architecture (not necessarily Arm) |
196+
| Embedded and Microcontroller | <ul><li>Understanding of programming languages such as C, C++ and assembly.</li> <li>Basic awareness of Linux OS, RTOSes.</li> <li>Fundamental knowledge of hardware and software architecture (not necessarily Arm)</li></ul> |
197197
| Server and Cloud | <ul><li> Understanding of web services and Linux.</li><li> Basic awareness of containerization and orchestration technologies such as Docker and Kubernetes.</li><li> Proficient in programming languages such as Python and Java.</li></ul> |
198198
| Mobile | <ul> <li> Experience with software development on mobile platforms such as Android. </li> <li> Experience with mobile development and testing frameworks. </li> </ul> |
199199
| Desktop and Laptop | <ul> <li> Experience with operating systems such as Windows and macOS. </li> <li> Experience with common development frameworks such as .NET and Electron. </li> Proficient in programming languages such as C++, Java and Python. </li> </ul> |
200200

201+
## Use Agent Skills for AI-assisted style compliance
201202

203+
If you're creating a Learning Path with the help of an AI assistant, you can use Agent Skills to check whether your content meets project guidelines.
202204

205+
Agent Skills are located in the project reporsitory at `.github/skills`. Skills cover Learning Path structure, writing style guidelines, as well as accessibility-related considerations such as alt-text for images.
203206

207+
A skill is invoked automatically depending on whether your prompt maps to the skill's `description` metadata. For example, to check for style violations on a given page, you can prompt something similar to:
204208

209+
```text
210+
Review this page in the Learning Path for style.
211+
```
212+
By using words such as "Learning Path" and "style", the prompt invokes the `writing-style-review` skill. The AI assistant returns with a set of style-related suggestions.
213+
214+
To check whether the Learning Path is structurally sound, you can prompt something similar to:
215+
216+
```text
217+
Review this Learning Path for structure.
218+
```
219+
220+
By using words such as "Learning Path" and "structure", the prompt invokes the `learning-path-structure-review` skill. The AI assistant returns with suggestions such as whether the Learning Path is task-oriented and has necessary files and sections.

0 commit comments

Comments
 (0)