Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions .claude/skills/deepwork_jobs.define/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hooks:
2. **Structured Questions Used**: Did the agent ask structured questions (using the AskUserQuestion tool) to gather user input?
3. **Document Detection**: For document-oriented workflows, did the agent detect patterns and offer doc spec creation?
4. **doc spec Created (if applicable)**: If a doc spec was needed, was it created in `.deepwork/doc_specs/[doc_spec_name].md` with proper quality criteria?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, document_type}` format?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, doc_spec}` format?
6. **Valid Against doc spec**: Does the job.yml conform to the job.yml doc spec quality criteria (valid identifier, semantic version, concise summary, rich description, complete steps, valid dependencies)?
7. **Clear Inputs/Outputs**: Does every step have clearly defined inputs and outputs?
8. **Logical Dependencies**: Do step dependencies make sense and avoid circular references?
Expand Down Expand Up @@ -84,19 +84,19 @@ Start by asking structured questions to understand what the user wants to accomp

**Check for document-focused patterns** in the user's description:
- Keywords: "report", "summary", "document", "create", "monthly", "quarterly", "for stakeholders", "for leadership"
- Final deliverable is a specific document type (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Final deliverable is a specific document (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Recurring documents with consistent structure

**If a document-oriented workflow is detected:**

1. Inform the user: "This workflow produces a specific document type. I recommend defining a Document Type Definition (doc spec) first to ensure consistent quality."
1. Inform the user: "This workflow produces a specific document type. I recommend defining a doc spec first to ensure consistent quality."

2. Ask structured questions to understand if they want to:
- Create a doc spec for the document type
- Create a doc spec for this document
- Use an existing doc spec (if any exist in `.deepwork/doc_specs/`)
- Skip doc spec and proceed with simple outputs

### Step 1.6: Define the Document Type Definition (if needed)
### Step 1.6: Define the Doc Spec (if needed)

When creating a doc spec, gather the following information:

Expand Down Expand Up @@ -170,7 +170,7 @@ When a step produces a document with a doc spec reference, use this format in jo
```yaml
outputs:
- file: reports/monthly_spending.md
document_type: .deepwork/doc_specs/monthly_aws_report.md
doc_spec: .deepwork/doc_specs/monthly_aws_report.md
```

The doc spec's quality criteria will automatically be included in the generated skill, ensuring consistent document quality.
Expand Down Expand Up @@ -269,7 +269,7 @@ This creates:

(Where `[job_name]` is the name of the NEW job you're creating, e.g., `competitive_research`)

**Document Type Definition**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.
**Doc Spec**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.

**Template reference**: See `.deepwork/jobs/deepwork_jobs/templates/job.yml.template` for the standard structure.

Expand Down Expand Up @@ -475,7 +475,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`

**Required outputs**:
- `job.yml`
**Document Type**: DeepWork Job Specification
**Doc Spec**: DeepWork Job Specification
> YAML specification file that defines a multi-step workflow job for AI agents
**Definition**: `.deepwork/doc_specs/job_spec.md`
**Target Audience**: AI agents executing jobs and developers defining workflows
Expand Down Expand Up @@ -540,9 +540,9 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`
outputs:
- filename.md # simple filename
- reports/analysis.md # path with directory
# With document type reference:
# With doc spec reference:
- file: report.md
document_type: .deepwork/doc_specs/report_type.md
doc_spec: .deepwork/doc_specs/report_type.md
dependencies:
- previous_step_id # steps that must complete first
```
Expand Down Expand Up @@ -651,7 +651,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`
from_step: research_competitors
outputs:
- file: positioning_report.md
document_type: .deepwork/doc_specs/positioning_report.md
doc_spec: .deepwork/doc_specs/positioning_report.md
dependencies:
- research_competitors
```
Expand All @@ -675,7 +675,7 @@ Stop hooks will automatically validate your work. The loop continues until all c
2. **Structured Questions Used**: Did the agent ask structured questions (using the AskUserQuestion tool) to gather user input?
3. **Document Detection**: For document-oriented workflows, did the agent detect patterns and offer doc spec creation?
4. **doc spec Created (if applicable)**: If a doc spec was needed, was it created in `.deepwork/doc_specs/[doc_spec_name].md` with proper quality criteria?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, document_type}` format?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, doc_spec}` format?
6. **Valid Against doc spec**: Does the job.yml conform to the job.yml doc spec quality criteria (valid identifier, semantic version, concise summary, rich description, complete steps, valid dependencies)?
7. **Clear Inputs/Outputs**: Does every step have clearly defined inputs and outputs?
8. **Logical Dependencies**: Do step dependencies make sense and avoid circular references?
Expand Down
4 changes: 2 additions & 2 deletions .claude/skills/deepwork_jobs.learn/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ For each learning identified, determine if it is:
- "Quality criteria should include checking for Y"
- "Add example of correct output format"

**doc spec-Related** (should improve document type definitions):
**doc spec-Related** (should improve doc spec files):
- Improvements to document quality criteria
- Changes to document structure or format
- Updated audience or frequency information
Expand Down Expand Up @@ -214,7 +214,7 @@ Review all instruction files for the job and identify content that:
If doc spec-related learnings were identified:

1. **Locate the doc spec file**
- Find doc spec references in job.yml outputs (look for `document_type: .deepwork/doc_specs/[doc_spec_name].md`)
- Find doc spec references in job.yml outputs (look for `doc_spec: .deepwork/doc_specs/[doc_spec_name].md`)
- doc spec files are at `.deepwork/doc_specs/[doc_spec_name].md`

2. **Update quality_criteria array**
Expand Down
8 changes: 4 additions & 4 deletions .claude/skills/deepwork_jobs.review_job_spec/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`

**Required outputs**:
- `job.yml`
**Document Type**: DeepWork Job Specification
**Doc Spec**: DeepWork Job Specification
> YAML specification file that defines a multi-step workflow job for AI agents
**Definition**: `.deepwork/doc_specs/job_spec.md`
**Target Audience**: AI agents executing jobs and developers defining workflows
Expand Down Expand Up @@ -349,9 +349,9 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`
outputs:
- filename.md # simple filename
- reports/analysis.md # path with directory
# With document type reference:
# With doc spec reference:
- file: report.md
document_type: .deepwork/doc_specs/report_type.md
doc_spec: .deepwork/doc_specs/report_type.md
dependencies:
- previous_step_id # steps that must complete first
```
Expand Down Expand Up @@ -460,7 +460,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`
from_step: research_competitors
outputs:
- file: positioning_report.md
document_type: .deepwork/doc_specs/positioning_report.md
doc_spec: .deepwork/doc_specs/positioning_report.md
dependencies:
- research_competitors
```
Expand Down
6 changes: 3 additions & 3 deletions .deepwork/doc_specs/job_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ steps:
outputs:
- filename.md # simple filename
- reports/analysis.md # path with directory
# With document type reference:
# With doc spec reference:
- file: report.md
document_type: .deepwork/doc_specs/report_type.md
doc_spec: .deepwork/doc_specs/report_type.md
dependencies:
- previous_step_id # steps that must complete first
```
Expand Down Expand Up @@ -184,7 +184,7 @@ steps:
from_step: research_competitors
outputs:
- file: positioning_report.md
document_type: .deepwork/doc_specs/positioning_report.md
doc_spec: .deepwork/doc_specs/positioning_report.md
dependencies:
- research_competitors
```
6 changes: 3 additions & 3 deletions .deepwork/jobs/deepwork_jobs/doc_specs/job_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ steps:
outputs:
- filename.md # simple filename
- reports/analysis.md # path with directory
# With document type reference:
# With doc spec reference:
- file: report.md
document_type: .deepwork/doc_specs/report_type.md
doc_spec: .deepwork/doc_specs/report_type.md
dependencies:
- previous_step_id # steps that must complete first
```
Expand Down Expand Up @@ -184,7 +184,7 @@ steps:
from_step: research_competitors
outputs:
- file: positioning_report.md
document_type: .deepwork/doc_specs/positioning_report.md
doc_spec: .deepwork/doc_specs/positioning_report.md
dependencies:
- research_competitors
```
10 changes: 5 additions & 5 deletions .deepwork/jobs/deepwork_jobs/job.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ changelog:
- version: "0.5.0"
changes: "Standardized on 'ask structured questions' phrasing for user input; Updated quality criteria hooks to verify phrase usage; Added guidance in implement.md to use phrase in generated instructions"
- version: "0.6.0"
changes: "Added Document Type Definition (doc spec) support; define.md now detects document-oriented workflows and guides doc spec creation; learn.md now identifies and applies doc spec-related improvements"
changes: "Added doc spec support; define.md now detects document-oriented workflows and guides doc spec creation; learn.md now identifies and applies doc spec-related improvements"
- version: "0.7.0"
changes: "Added job.yml doc spec; define step now outputs job.yml with document_type reference for quality validation"
changes: "Added job.yml doc spec; define step now outputs job.yml with doc_spec reference for quality validation"
- version: "0.8.0"
changes: "Added review_job_spec step between define and implement for doc spec-based quality validation using sub-agent review"
- version: "0.9.0"
Expand All @@ -43,14 +43,14 @@ steps:
description: "What complex task or workflow are you trying to accomplish?"
outputs:
- file: job.yml
document_type: .deepwork/doc_specs/job_spec.md
doc_spec: .deepwork/doc_specs/job_spec.md
dependencies: []
quality_criteria:
- "**User Understanding**: Did the agent fully understand the user's workflow by asking structured questions?"
- "**Structured Questions Used**: Did the agent ask structured questions (using the AskUserQuestion tool) to gather user input?"
- "**Document Detection**: For document-oriented workflows, did the agent detect patterns and offer doc spec creation?"
- "**doc spec Created (if applicable)**: If a doc spec was needed, was it created in `.deepwork/doc_specs/[doc_spec_name].md` with proper quality criteria?"
- "**doc spec References**: Are document outputs properly linked to their doc specs using `{file, document_type}` format?"
- "**doc spec References**: Are document outputs properly linked to their doc specs using `{file, doc_spec}` format?"
- "**Valid Against doc spec**: Does the job.yml conform to the job.yml doc spec quality criteria (valid identifier, semantic version, concise summary, rich description, complete steps, valid dependencies)?"
- "**Clear Inputs/Outputs**: Does every step have clearly defined inputs and outputs?"
- "**Logical Dependencies**: Do step dependencies make sense and avoid circular references?"
Expand All @@ -68,7 +68,7 @@ steps:
from_step: define
outputs:
- file: job.yml
document_type: .deepwork/doc_specs/job_spec.md
doc_spec: .deepwork/doc_specs/job_spec.md
dependencies:
- define
quality_criteria:
Expand Down
12 changes: 6 additions & 6 deletions .deepwork/jobs/deepwork_jobs/steps/define.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ Start by asking structured questions to understand what the user wants to accomp

**Check for document-focused patterns** in the user's description:
- Keywords: "report", "summary", "document", "create", "monthly", "quarterly", "for stakeholders", "for leadership"
- Final deliverable is a specific document type (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Final deliverable is a specific document (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Recurring documents with consistent structure

**If a document-oriented workflow is detected:**

1. Inform the user: "This workflow produces a specific document type. I recommend defining a Document Type Definition (doc spec) first to ensure consistent quality."
1. Inform the user: "This workflow produces a specific document type. I recommend defining a doc spec first to ensure consistent quality."

2. Ask structured questions to understand if they want to:
- Create a doc spec for the document type
- Create a doc spec for this document
- Use an existing doc spec (if any exist in `.deepwork/doc_specs/`)
- Skip doc spec and proceed with simple outputs

### Step 1.6: Define the Document Type Definition (if needed)
### Step 1.6: Define the Doc Spec (if needed)

When creating a doc spec, gather the following information:

Expand Down Expand Up @@ -121,7 +121,7 @@ When a step produces a document with a doc spec reference, use this format in jo
```yaml
outputs:
- file: reports/monthly_spending.md
document_type: .deepwork/doc_specs/monthly_aws_report.md
doc_spec: .deepwork/doc_specs/monthly_aws_report.md
```

The doc spec's quality criteria will automatically be included in the generated skill, ensuring consistent document quality.
Expand Down Expand Up @@ -220,7 +220,7 @@ This creates:

(Where `[job_name]` is the name of the NEW job you're creating, e.g., `competitive_research`)

**Document Type Definition**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.
**Doc Spec**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.

**Template reference**: See `.deepwork/jobs/deepwork_jobs/templates/job.yml.template` for the standard structure.

Expand Down
4 changes: 2 additions & 2 deletions .deepwork/jobs/deepwork_jobs/steps/learn.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ For each learning identified, determine if it is:
- "Quality criteria should include checking for Y"
- "Add example of correct output format"

**doc spec-Related** (should improve document type definitions):
**doc spec-Related** (should improve doc spec files):
- Improvements to document quality criteria
- Changes to document structure or format
- Updated audience or frequency information
Expand Down Expand Up @@ -166,7 +166,7 @@ Review all instruction files for the job and identify content that:
If doc spec-related learnings were identified:

1. **Locate the doc spec file**
- Find doc spec references in job.yml outputs (look for `document_type: .deepwork/doc_specs/[doc_spec_name].md`)
- Find doc spec references in job.yml outputs (look for `doc_spec: .deepwork/doc_specs/[doc_spec_name].md`)
- doc spec files are at `.deepwork/doc_specs/[doc_spec_name].md`

2. **Update quality_criteria array**
Expand Down
16 changes: 8 additions & 8 deletions .gemini/skills/deepwork_jobs/define.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,19 @@ Start by asking structured questions to understand what the user wants to accomp

**Check for document-focused patterns** in the user's description:
- Keywords: "report", "summary", "document", "create", "monthly", "quarterly", "for stakeholders", "for leadership"
- Final deliverable is a specific document type (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Final deliverable is a specific document (e.g., "AWS spending report", "competitive analysis", "sprint summary")
- Recurring documents with consistent structure

**If a document-oriented workflow is detected:**

1. Inform the user: "This workflow produces a specific document type. I recommend defining a Document Type Definition (doc spec) first to ensure consistent quality."
1. Inform the user: "This workflow produces a specific document type. I recommend defining a doc spec first to ensure consistent quality."

2. Ask structured questions to understand if they want to:
- Create a doc spec for the document type
- Create a doc spec for this document
- Use an existing doc spec (if any exist in `.deepwork/doc_specs/`)
- Skip doc spec and proceed with simple outputs

### Step 1.6: Define the Document Type Definition (if needed)
### Step 1.6: Define the Doc Spec (if needed)

When creating a doc spec, gather the following information:

Expand Down Expand Up @@ -141,7 +141,7 @@ When a step produces a document with a doc spec reference, use this format in jo
```yaml
outputs:
- file: reports/monthly_spending.md
document_type: .deepwork/doc_specs/monthly_aws_report.md
doc_spec: .deepwork/doc_specs/monthly_aws_report.md
```

The doc spec's quality criteria will automatically be included in the generated skill, ensuring consistent document quality.
Expand Down Expand Up @@ -240,7 +240,7 @@ This creates:

(Where `[job_name]` is the name of the NEW job you're creating, e.g., `competitive_research`)

**Document Type Definition**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.
**Doc Spec**: See `.deepwork/doc_specs/job_spec.md` for the complete specification with quality criteria.

**Template reference**: See `.deepwork/jobs/deepwork_jobs/templates/job.yml.template` for the standard structure.

Expand Down Expand Up @@ -446,7 +446,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`

**Required outputs**:
- `job.yml`
**Document Type**: DeepWork Job Specification
**Doc Spec**: DeepWork Job Specification
> YAML specification file that defines a multi-step workflow job for AI agents
**Definition**: `.deepwork/doc_specs/job_spec.md`
**Target Audience**: AI agents executing jobs and developers defining workflows
Expand All @@ -471,7 +471,7 @@ Use branch format: `deepwork/deepwork_jobs-[instance]-YYYYMMDD`
2. **Structured Questions Used**: Did the agent ask structured questions (using the AskUserQuestion tool) to gather user input?
3. **Document Detection**: For document-oriented workflows, did the agent detect patterns and offer doc spec creation?
4. **doc spec Created (if applicable)**: If a doc spec was needed, was it created in `.deepwork/doc_specs/[doc_spec_name].md` with proper quality criteria?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, document_type}` format?
5. **doc spec References**: Are document outputs properly linked to their doc specs using `{file, doc_spec}` format?
6. **Valid Against doc spec**: Does the job.yml conform to the job.yml doc spec quality criteria (valid identifier, semantic version, concise summary, rich description, complete steps, valid dependencies)?
7. **Clear Inputs/Outputs**: Does every step have clearly defined inputs and outputs?
8. **Logical Dependencies**: Do step dependencies make sense and avoid circular references?
Expand Down
Loading