Skip to content

Commit 7a9603e

Browse files
jabrenajabrena
committed
feat(skills): Improve structure of any SKILL.md with a defined Workflow
1 parent cd34e16 commit 7a9603e

16 files changed

Lines changed: 296 additions & 0 deletions

File tree

‎skills-generator/src/main/resources/skill-indexes/151-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@ Provide a complete JMeter performance testing solution by creating the run-jmete
4343
</trigger-list>
4444
</triggers>
4545

46+
<steps>
47+
<step number="1">
48+
<step-title>Verify JMeter prerequisite</step-title>
49+
<step-content>Check `jmeter --version` and stop with guidance if JMeter is not installed or not available in PATH.</step-content>
50+
</step>
51+
<step number="2">
52+
<step-title>Read JMeter reference template</step-title>
53+
<step-content>Read `references/151-java-performance-jmeter.md` and use the `run-jmeter.sh` template exactly as provided.</step-content>
54+
</step>
55+
<step number="3">
56+
<step-title>Create script and project structure</step-title>
57+
<step-content>Create `run-jmeter.sh` in project root, ensure required JMeter directories/files exist, and apply executable permission with `chmod +x`.</step-content>
58+
</step>
59+
<step number="4">
60+
<step-title>Explain usage and environment overrides</step-title>
61+
<step-content>Document CLI options (`-l`, `-t`, `-r`, `-g`, `-h`) and environment variable overrides (`JMETER_LOOPS`, `JMETER_THREADS`, `JMETER_RAMP_UP`).</step-content>
62+
</step>
63+
</steps>
64+
4665
<references>
4766
<reference-list>
4867
<reference>references/151-java-performance-jmeter.md</reference>

‎skills-generator/src/main/resources/skill-indexes/161-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,25 @@ Set up the Java profiling detection phase: automated environment setup with asyn
4444
</trigger-list>
4545
</triggers>
4646

47+
<steps>
48+
<step number="1">
49+
<step-title>Read profiling setup reference</step-title>
50+
<step-content>Read `references/161-java-profiling-detect.md` and use script templates exactly as provided.</step-content>
51+
</step>
52+
<step number="2">
53+
<step-title>Create profiler workspace and scripts</step-title>
54+
<step-content>Create `profiler/scripts` and `profiler/results`, copy setup/profile scripts verbatim, and make scripts executable.</step-content>
55+
</step>
56+
<step number="3">
57+
<step-title>Run application with profiling compatibility</step-title>
58+
<step-content>Start Java process with required profiling JVM flags and verify target process availability for profiler attachment.</step-content>
59+
</step>
60+
<step number="4">
61+
<step-title>Collect profiling artifacts</step-title>
62+
<step-content>Capture CPU/memory/lock/GC/I/O data and produce timestamped flamegraph and JFR outputs for analysis.</step-content>
63+
</step>
64+
</steps>
65+
4766
<references>
4867
<reference-list>
4968
<reference>references/161-java-profiling-detect.md</reference>

‎skills-generator/src/main/resources/skill-indexes/162-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,25 @@ Analyze profiling results systematically: inventory results (flamegraphs, JFR, G
4848
</trigger-list>
4949
</triggers>
5050

51+
<steps>
52+
<step number="1">
53+
<step-title>Read analysis reference and inventory inputs</step-title>
54+
<step-content>Read `references/162-java-profiling-analyze.md` and inventory profiling artifacts in `profiler/results/`.</step-content>
55+
</step>
56+
<step number="2">
57+
<step-title>Validate data quality and assumptions</step-title>
58+
<step-content>Confirm datasets represent realistic load conditions and record assumptions/limitations before drawing conclusions.</step-content>
59+
</step>
60+
<step number="3">
61+
<step-title>Identify and prioritize bottlenecks</step-title>
62+
<step-content>Analyze memory/CPU/threading findings, cross-reference multiple files, and prioritize issues by Impact/Effort.</step-content>
63+
</step>
64+
<step number="4">
65+
<step-title>Document findings and solution options</step-title>
66+
<step-content>Create `docs/profiling-problem-analysis-YYYYMMDD.md` and `docs/profiling-solutions-YYYYMMDD.md` with quantitative evidence.</step-content>
67+
</step>
68+
</steps>
69+
5170
<references>
5271
<reference-list>
5372
<reference>references/162-java-profiling-analyze.md</reference>

‎skills-generator/src/main/resources/skill-indexes/163-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,25 @@ Implement refactoring based on profiling analysis: review profiling-problem-anal
4242
</trigger-list>
4343
</triggers>
4444

45+
<steps>
46+
<step number="1">
47+
<step-title>Review profiling analysis artifacts</step-title>
48+
<step-content>Read `docs/profiling-problem-analysis-YYYYMMDD.md` and `docs/profiling-solutions-YYYYMMDD.md` to select target bottlenecks.</step-content>
49+
</step>
50+
<step number="2">
51+
<step-title>Apply targeted performance refactors</step-title>
52+
<step-content>Implement focused code changes for documented CPU, memory, or threading hotspots, incrementally and safely.</step-content>
53+
</step>
54+
<step number="3">
55+
<step-title>Verify behavior and performance build integrity</step-title>
56+
<step-content>Run `./mvnw clean verify` or `mvn clean verify`; if tests fail, fix issues before continuing.</step-content>
57+
</step>
58+
<step number="4">
59+
<step-title>Prepare handoff for verification phase</step-title>
60+
<step-content>Summarize implemented changes and expected metric improvements for Step 4 comparison.</step-content>
61+
</step>
62+
</steps>
63+
4564
<references>
4665
<reference-list>
4766
<reference>references/163-java-profiling-refactor.md</reference>

‎skills-generator/src/main/resources/skill-indexes/164-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,25 @@ Verify performance optimizations through rigorous before/after comparison: ensur
4848
</trigger-list>
4949
</triggers>
5050

51+
<steps>
52+
<step number="1">
53+
<step-title>Read verification reference and confirm baseline data</step-title>
54+
<step-content>Read `references/164-java-profiling-verify.md` and verify baseline artifacts exist and are non-empty.</step-content>
55+
</step>
56+
<step number="2">
57+
<step-title>Generate post-refactoring profiling data</step-title>
58+
<step-content>Run profiling with identical load/test conditions to produce comparable post-refactoring artifacts.</step-content>
59+
</step>
60+
<step number="3">
61+
<step-title>Compare before/after metrics and visuals</step-title>
62+
<step-content>Perform quantitative comparisons for memory/CPU/GC/threading and side-by-side flamegraph analysis.</step-content>
63+
</step>
64+
<step number="4">
65+
<step-title>Document final verification outcome</step-title>
66+
<step-content>Create comparison and final results reports with regressions, gains, and reproducible scenario details.</step-content>
67+
</step>
68+
</steps>
69+
5170
<references>
5271
<reference-list>
5372
<reference>references/164-java-profiling-verify.md</reference>

‎skills-generator/src/main/resources/skill-indexes/170-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,25 @@ Generate comprehensive Java project documentation through a modular, step-based
4040
</trigger-list>
4141
</triggers>
4242

43+
<steps>
44+
<step number="1">
45+
<step-title>Validate project before documentation changes</step-title>
46+
<step-content>Run `./mvnw validate` or `mvn validate` and stop immediately if validation fails.</step-content>
47+
</step>
48+
<step number="2">
49+
<step-title>Read documentation reference and gather scope</step-title>
50+
<step-content>Read `references/170-java-documentation.md` and identify required outputs (README, package-info, Javadoc enhancements).</step-content>
51+
</step>
52+
<step number="3">
53+
<step-title>Generate selected documentation artifacts</step-title>
54+
<step-content>Create or update documentation using the selected file-handling strategy (overwrite/add/backup/skip).</step-content>
55+
</step>
56+
<step number="4">
57+
<step-title>Run documentation validation checks</step-title>
58+
<step-content>Execute `./mvnw clean compile` and `./mvnw javadoc:javadoc` (or equivalent) to validate generated docs.</step-content>
59+
</step>
60+
</steps>
61+
4362
<references>
4463
<reference-list>
4564
<reference>references/170-java-documentation.md</reference>

‎skills-generator/src/main/resources/skill-indexes/180-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,25 @@ Implement effective Java logging following standardized frameworks, meaningful l
4545
</trigger-list>
4646
</triggers>
4747

48+
<steps>
49+
<step number="1">
50+
<step-title>Compile project before logging changes</step-title>
51+
<step-content>Run `./mvnw compile` or `mvn compile` and stop immediately if compilation fails.</step-content>
52+
</step>
53+
<step number="2">
54+
<step-title>Read logging reference and assess current observability</step-title>
55+
<step-content>Read `references/180-java-observability-logging.md` and evaluate framework usage, log levels, sensitive-data handling, and config gaps.</step-content>
56+
</step>
57+
<step number="3">
58+
<step-title>Apply logging and observability improvements</step-title>
59+
<step-content>Implement selected framework/configuration/practice changes, including secure logging and monitoring integration where applicable.</step-content>
60+
</step>
61+
<step number="4">
62+
<step-title>Verify with full build</step-title>
63+
<step-content>Run `./mvnw clean verify` or `mvn clean verify` after applying improvements.</step-content>
64+
</step>
65+
</steps>
66+
4867
<references>
4968
<reference-list>
5069
<reference>references/180-java-observability-logging.md</reference>

‎skills-generator/src/main/resources/skill-indexes/200-skill.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,25 @@ Generate a comprehensive AGENTS.md file for Java repositories through a modular,
4141
</trigger-list>
4242
</triggers>
4343

44+
<steps>
45+
<step number="1">
46+
<step-title>Review repository context before drafting</step-title>
47+
<step-content>Inspect project structure and existing documentation to prepare accurate responses for the AGENTS.md discovery phase.</step-content>
48+
</step>
49+
<step number="2">
50+
<step-title>Read AGENTS generation reference</step-title>
51+
<step-content>Read `references/200-agents-md.md` and follow its generation patterns and safeguards.</step-content>
52+
</step>
53+
<step number="3">
54+
<step-title>Run interactive requirements capture</step-title>
55+
<step-content>Gather role, tech stack, commands, workflow, and boundaries in a modular step-based conversation.</step-content>
56+
</step>
57+
<step number="4">
58+
<step-title>Generate AGENTS.md artifact</step-title>
59+
<step-content>Create AGENTS.md with ✅ Always do / ⚠️ Ask first / 🚫 Never do boundaries and repository-specific conventions.</step-content>
60+
</step>
61+
</steps>
62+
4463
<references>
4564
<reference-list>
4665
<reference>references/200-agents-md.md</reference>

‎skills/151-java-performance-jmeter/SKILL.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ JMeter must be installed and available in PATH. If not available, show a message
3636
- Refactor the code with JMeter performance testing
3737
- Add JMeter support
3838

39+
## Workflow
40+
41+
1. **Verify JMeter prerequisite**
42+
43+
Check `jmeter --version` and stop with guidance if JMeter is not installed or not available in PATH.
44+
45+
2. **Read JMeter reference template**
46+
47+
Read `references/151-java-performance-jmeter.md` and use the `run-jmeter.sh` template exactly as provided.
48+
49+
3. **Create script and project structure**
50+
51+
Create `run-jmeter.sh` in project root, ensure required JMeter directories/files exist, and apply executable permission with `chmod +x`.
52+
53+
4. **Explain usage and environment overrides**
54+
55+
Document CLI options (`-l`, `-t`, `-r`, `-g`, `-h`) and environment variable overrides (`JMETER_LOOPS`, `JMETER_THREADS`, `JMETER_RAMP_UP`).
56+
3957
## Reference
4058

4159
For detailed guidance, examples, and constraints, see [references/151-java-performance-jmeter.md](references/151-java-performance-jmeter.md).

‎skills/161-java-profiling-detect/SKILL.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ Copy bash scripts exactly from templates. Ensure JVM flags are applied for profi
3737
- Refactor the code with profiling
3838
- Add profiling support
3939

40+
## Workflow
41+
42+
1. **Read profiling setup reference**
43+
44+
Read `references/161-java-profiling-detect.md` and use script templates exactly as provided.
45+
46+
2. **Create profiler workspace and scripts**
47+
48+
Create `profiler/scripts` and `profiler/results`, copy setup/profile scripts verbatim, and make scripts executable.
49+
50+
3. **Run application with profiling compatibility**
51+
52+
Start Java process with required profiling JVM flags and verify target process availability for profiler attachment.
53+
54+
4. **Collect profiling artifacts**
55+
56+
Capture CPU/memory/lock/GC/I/O data and produce timestamped flamegraph and JFR outputs for analysis.
57+
4058
## Reference
4159

4260
For detailed guidance, examples, and constraints, see [references/161-java-profiling-detect.md](references/161-java-profiling-detect.md).

0 commit comments

Comments
 (0)