You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: update source files for deepwork_jobs instead of generated files
Update the source templates in src/deepwork/standard_jobs/deepwork_jobs/:
- job.yml: Enhanced description, added skills section, updated stop_hooks
- steps/define.md: Added workflow context and skills guidance sections
The previous commit incorrectly modified the generated files in .deepwork/jobs/.
These source files are the origin that gets synced to .deepwork/jobs/ during
`deepwork install`.
For each step, consider whether it would benefit from **quality validation loops**. Stop hooks allow the AI agent to iteratively refine its work until quality criteria are met.
88
196
@@ -129,7 +237,7 @@ stop_hooks:
129
237
130
238
**Encourage prompt-based hooks** - They leverage the AI's ability to understand context and make nuanced quality judgments. Script hooks are best for objective checks (syntax, format, tests).
131
239
132
-
### Step 5: Create the job.yml Specification
240
+
### Step 7: Create the job.yml Specification
133
241
134
242
Only after you have complete understanding, create the `job.yml` file:
135
243
@@ -156,6 +264,25 @@ changelog:
156
264
- version: "1.0.0"
157
265
changes: "Initial job creation"
158
266
267
+
# Optional: Skills for workflow guidance or domain expertise
268
+
skills:
269
+
- name: [job_name]-guide
270
+
description: |
271
+
Use this skill when users ask about [job purpose] or want to start
272
+
the workflow casually. Triggered by phrases like "[example phrases]"
273
+
user_invocable: false
274
+
content: |
275
+
# [Job Name] Workflow Guide
276
+
277
+
[Explain the workflow and when to use each step]
278
+
279
+
## Steps
280
+
1. Run `/[job_name].[step1_id]` - [what it does]
281
+
2. Run `/[job_name].[step2_id]` - [what it does]
282
+
283
+
## Tips
284
+
[Domain-specific guidance]
285
+
159
286
steps:
160
287
- id: [step_id]
161
288
name: "[Step Name]"
@@ -197,8 +324,10 @@ steps:
197
324
- No circular dependencies
198
325
- At least one output per step
199
326
- The `summary` should be concise (max 200 chars)
200
-
- The `description` should provide rich context for future refinement
327
+
- The `description` should provide rich context including workflow explanation and usage guidance
201
328
- Include a `changelog` section with an initial entry for version 1.0.0
329
+
- Consider adding a `skills` section for workflow guidance or domain expertise
330
+
- Skill names use lowercase with hyphens (not underscores)
202
331
203
332
## Example Dialog
204
333
@@ -324,14 +453,18 @@ Before creating the job.yml, ensure:
324
453
- Job name: lowercase, underscores, no spaces
325
454
- Version: semantic versioning (1.0.0)
326
455
- Summary: concise, under 200 characters
327
-
- Description: detailed, provides context
456
+
- Description: detailed, provides workflow context, explains how to use the job
328
457
- Step IDs: unique, descriptive, lowercase with underscores
329
458
- Dependencies: must reference existing step IDs
330
459
- File inputs: `from_step` must be in dependencies
331
460
- At least one output per step
332
461
- Outputs can be filenames (e.g., `report.md`) or paths (e.g., `reports/analysis.md`)
333
462
- File paths in outputs should match where files will actually be created
334
463
- No circular dependencies
464
+
- Skills (if included):
465
+
- Name: lowercase with hyphens, max 64 chars
466
+
- Description: explains when Claude should use this skill
467
+
- Content: provides workflow guidance or domain knowledge
335
468
336
469
## Output Format
337
470
@@ -354,6 +487,13 @@ After creating the file:
354
487
- All steps have clear inputs and outputs
355
488
- Dependencies make logical sense
356
489
- Summary is concise and descriptive
357
-
- Description provides rich context for future refinement
490
+
- Description provides rich context including:
491
+
- Workflow explanation (how steps connect)
492
+
- Background context users need
493
+
- Usage guidance
494
+
- Skills (if included) have:
495
+
- Clear description of when Claude should invoke them
496
+
- Comprehensive content with workflow steps and guidance
497
+
- Domain-specific tips where relevant
358
498
- Specification is valid YAML and follows the schema
0 commit comments