diff --git a/.deepwork/jobs/test_job_flow/AGENTS.md b/.deepwork/jobs/test_job_flow/AGENTS.md index 7feb4a29..32c2b8c0 100644 --- a/.deepwork/jobs/test_job_flow/AGENTS.md +++ b/.deepwork/jobs/test_job_flow/AGENTS.md @@ -13,9 +13,7 @@ This folder and its subfolders are managed using `deepwork_jobs` workflows. ``` . ├── AGENTS.md # This file - project context and guidance -├── job.yml # Job specification (created by define step) -├── steps/ # Step instruction files (created by implement step) -│ └── *.md # One file per step +├── job.yml # Job specification with inline step instructions ├── hooks/ # Custom validation scripts and prompts │ └── *.md|*.sh # Hook files referenced in job.yml ├── scripts/ # Reusable scripts and utilities created during job execution diff --git a/.deepwork/jobs/test_job_flow/job.yml b/.deepwork/jobs/test_job_flow/job.yml index d7954740..b5932cee 100644 --- a/.deepwork/jobs/test_job_flow/job.yml +++ b/.deepwork/jobs/test_job_flow/job.yml @@ -90,8 +90,8 @@ workflows: completed on first try or required retries. 2. **Verify completion**: Confirm `.deepwork/jobs/detailed_test_review/job.yml` - exists with expected structure (2 steps, correct outputs, reviews). Check - step instruction files exist in `steps/`. + exists with expected structure (2 steps, correct outputs, reviews, and + inline step instructions). 3. **Identify friction points**: Look for errors, workarounds, retries, confusion, unnecessary steps, slow paths, and missing guidance in the transcript. diff --git a/.deepwork/learning-agents/consistency-reviewer/core-knowledge.md b/.deepwork/learning-agents/consistency-reviewer/core-knowledge.md index 1e7ab17a..0726c467 100644 --- a/.deepwork/learning-agents/consistency-reviewer/core-knowledge.md +++ b/.deepwork/learning-agents/consistency-reviewer/core-knowledge.md @@ -34,7 +34,7 @@ There are exactly three types of jobs. Confusing them is one of the most common ### Key File Patterns - `job.yml` — Job definitions with steps, workflows, outputs, reviews, quality criteria -- `steps/*.md` — Step instruction files (markdown with structured guidance) +- Step instructions are inlined in `job.yml` (the `steps/` folder pattern is deprecated) - `hooks/` — Lifecycle hooks (after_agent, before_tool, etc.) - `.claude/agents/*.md` — Agent definitions with YAML frontmatter (name, description) - `AGENTS.md` — Bespoke learnings and context for a working directory diff --git a/.github/workflows/claude-code-test.yml b/.github/workflows/claude-code-test.yml index d1be4407..04d10b87 100644 --- a/.github/workflows/claude-code-test.yml +++ b/.github/workflows/claude-code-test.yml @@ -310,18 +310,12 @@ jobs: exit 1 fi - # Verify step files were created - echo "=== Checking step files were created ===" - if [ -f ".deepwork/jobs/fruits/steps/identify.md" ] && [ -f ".deepwork/jobs/fruits/steps/classify.md" ]; then - echo "SUCCESS: Step instruction files created" - echo "--- identify.md ---" - cat .deepwork/jobs/fruits/steps/identify.md - echo "" - echo "--- classify.md ---" - cat .deepwork/jobs/fruits/steps/classify.md + # Verify step instructions are inlined in job.yml + echo "=== Checking step instructions are inlined ===" + if grep -q 'instructions:' .deepwork/jobs/fruits/job.yml; then + echo "SUCCESS: Step instructions are inlined in job.yml" else - echo "ERROR: Step files were not created" - ls -la .deepwork/jobs/fruits/steps/ || echo "No steps directory" + echo "ERROR: No inline step instructions found in job.yml" exit 1 fi diff --git a/CHANGELOG.md b/CHANGELOG.md index a589dfea..6f445b56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Deprecated the `steps/` folder pattern for job definitions — step instructions are now inlined in `job.yml`; moved supplemental reference files from `steps/` to job root directories +- Repair workflow now instructs agents to `git rm` step instruction files after inlining + ### Fixed ### Removed diff --git a/doc/doc-specs.md b/doc/doc-specs.md index ace34612..6570c7a3 100644 --- a/doc/doc-specs.md +++ b/doc/doc-specs.md @@ -93,7 +93,8 @@ steps: - id: generate_report name: "Generate Monthly Report" description: "Create the monthly AWS spending report" - instructions_file: steps/generate_report.md + instructions: | + Generate the monthly AWS spending report... outputs: - file: reports/aws_spending.md doc_spec: .deepwork/doc_specs/monthly_aws_report.md diff --git a/library/jobs/.deepreview b/library/jobs/.deepreview index 36cb9258..e3b58dd9 100644 --- a/library/jobs/.deepreview +++ b/library/jobs/.deepreview @@ -30,9 +30,8 @@ library_job_portability: match: include: - "**/job.yml" - - "**/steps/*.md" - - "**/readme.md" - "**/conventions.md" + - "**/readme.md" - "**/templates/*.template" exclude: - ".deepreview" @@ -51,7 +50,7 @@ library_job_portability: - Workspace-relative paths that assume a specific repo layout (e.g., `.repos/acme/api/` or `/code/myproject/`) - Acceptable: relative paths within the job directory (e.g., `steps/foo.md`, + Acceptable: relative paths within the job directory (e.g., `templates/bar.yml`, `templates/bar.yml`) and generic placeholders like ``. ## Personal and Private Information diff --git a/library/jobs/README.md b/library/jobs/README.md index 62e4e212..eef71dac 100644 --- a/library/jobs/README.md +++ b/library/jobs/README.md @@ -74,49 +74,22 @@ library/jobs/ │ ├── job.yml │ ├── AGENTS.md # Agent context and learnings │ ├── CLAUDE.md -> AGENTS.md -│ ├── requirements.md # RFC 2119 requirements specification -│ └── steps/ # Step instruction files (also inlined in job.yml) +│ └── requirements.md # RFC 2119 requirements specification ├── platform_engineer/ # Platform engineering workflows │ ├── job.yml │ ├── AGENTS.md # Agent context and learnings │ ├── CLAUDE.md -> AGENTS.md │ ├── conventions.md # RFC 2119 platform engineering standards │ ├── readme.md -│ ├── steps/ # Step instruction files (also inlined in job.yml) │ └── templates/ # Output templates ├── repo/ -│ ├── job.yml # Job definition (name, steps, workflows) -│ ├── readme.md # Job-specific documentation -│ └── steps/ -│ ├── detect_platform.md -│ ├── ensure_labels.md -│ ├── check_branch_protection.md -│ ├── check_milestones.md -│ ├── check_boards.md -│ ├── setup_report.md -│ ├── audit_labels.md -│ ├── audit_branch_protection.md -│ ├── audit_milestones.md -│ ├── audit_boards.md -│ └── doctor_report.md +│ ├── job.yml # Job definition (self-contained with inline instructions) +│ └── readme.md # Job-specific documentation ├── research/ -│ ├── job.yml # Job definition (name, steps, workflows) +│ ├── job.yml # Job definition (self-contained with inline instructions) │ ├── readme.md # Job-specific documentation │ ├── AGENTS.md # Agent context and learnings -│ ├── CLAUDE.md -> AGENTS.md -│ └── steps/ -│ ├── scope.md -│ ├── choose_platforms.md -│ ├── gather.md -│ ├── gather_quick.md -│ ├── synthesize.md -│ ├── summarize.md -│ ├── report.md -│ ├── parse.md -│ ├── file.md -│ ├── ingest_material.md -│ ├── analyze.md -│ └── plan.md +│ └── CLAUDE.md -> AGENTS.md └── spec_driven_development/ ├── job.yml # Job definition (self-contained with inline instructions) └── readme.md # Job-specific documentation @@ -147,7 +120,7 @@ The job definition file contains: - `process_requirements`: Optional quality criteria for the work process - `post_workflow_instructions`: Optional instructions shown after workflow completes -Step instructions are inlined in `job.yml`. Some jobs also retain separate `steps/*.md` files from earlier versions; the inline `instructions` in `job.yml` are the canonical source. +Step instructions are inlined in `job.yml` using YAML block scalars (`instructions: |`). ## Using a Job from the Library diff --git a/library/jobs/engineer/.deepreview b/library/jobs/engineer/.deepreview index fa22a5f3..44a634ec 100644 --- a/library/jobs/engineer/.deepreview +++ b/library/jobs/engineer/.deepreview @@ -1,16 +1,15 @@ job_definition_review: - description: "Review job.yml, requirements.md, and step instructions for correctness, completeness, and coherence as a holistic workflow." + description: "Review job.yml (with inline step instructions) and requirements.md for correctness, completeness, and coherence as a holistic workflow." match: include: - "job.yml" - - "steps/*.md" - "requirements.md" review: strategy: matches_together instructions: | - Review this DeepWork job definition (job.yml), its requirements (requirements.md), - and its step instruction files (steps/*.md) holistically. Check that they form a - coherent, well-structured workflow that an AI agent can execute reliably. + Review this DeepWork job definition (job.yml) and its requirements (requirements.md) + holistically. Check that they form a coherent, well-structured workflow that an AI + agent can execute reliably. ## Reference Material @@ -42,13 +41,13 @@ job_definition_review: - Intermediate outputs that are not meant to be persisted should be in .deepwork/tmp (and the name should indicate that) - Final outputs follow project conventions (not hidden in dot-directories, descriptive names, appropriate use of subdirectories) - ### 4. Step Instructions Match job.yml - - Every step defined in job.yml has a corresponding instruction file + ### 4. Inline Step Instructions + - Every step defined in job.yml has inline `instructions:` content - Step instruction content aligns with the step's described purpose - Instructions reference the correct input and output filenames from job.yml - Instructions do not duplicate content already in `common_job_info_provided_to_all_steps_at_runtime` - - If there is duplicated content amongst the instruction files, it should be moved to `common_job_info_provided_to_all_steps_at_runtime` and removed from the instruction files - - If there is content that is needed in multiple steps but not all, it should be moved to its own file and referenced in the steps + - If there is duplicated content amongst step instructions, it should be moved to `common_job_info_provided_to_all_steps_at_runtime` + - If there is content that is needed in multiple steps but not all, it should be moved to a shared file in the job directory and referenced in the steps ### 5. Quality Reviews - Steps with complex or final outputs have reviews defined @@ -58,8 +57,8 @@ job_definition_review: - Steps with no meaningful quality checks use `reviews: []` ### 6. Step Instruction Quality - - Each instruction file follows the structure and section headings defined in - `step_instruction.md.template` for this job type. + - Each step's inline instructions follow the structure and section headings + defined in `step_instruction.md.template` for this job type. - The sections clearly communicate: what the step is trying to achieve, what the agent should do, what to produce (including format/examples), and how quality will be evaluated. diff --git a/library/jobs/engineer/AGENTS.md b/library/jobs/engineer/AGENTS.md index c8de832c..a88e9d14 100644 --- a/library/jobs/engineer/AGENTS.md +++ b/library/jobs/engineer/AGENTS.md @@ -11,18 +11,8 @@ It is a library job — available for users to adopt but not auto-installed by t engineer/ ├── AGENTS.md # This file ├── CLAUDE.md -> AGENTS.md # Symlink for Claude Code -├── job.yml # Job definition -├── requirements.md # RFC 2119 requirements specification -└── steps/ - ├── translate_issue.md - ├── initialize_branch.md - ├── red_tests.md - ├── green_implementation.md - ├── finalize_pr.md - ├── product_sync.md - ├── check_agent_md.md - ├── check_context.md - └── doctor_report.md +├── job.yml # Job definition (all step instructions inlined) +└── requirements.md # RFC 2119 requirements specification ``` ## Workflows diff --git a/library/jobs/platform_engineer/AGENTS.md b/library/jobs/platform_engineer/AGENTS.md index 9fe7db60..82c2d887 100644 --- a/library/jobs/platform_engineer/AGENTS.md +++ b/library/jobs/platform_engineer/AGENTS.md @@ -19,7 +19,6 @@ platform_engineer/ ├── conventions.md # RFC 2119 platform engineering standards ├── readme.md # User-facing documentation ├── AGENTS.md # This file — agent context and learnings -├── steps/ # Step instruction files └── templates/ # Output templates ``` diff --git a/library/jobs/research/AGENTS.md b/library/jobs/research/AGENTS.md index bb66f954..75524102 100644 --- a/library/jobs/research/AGENTS.md +++ b/library/jobs/research/AGENTS.md @@ -19,28 +19,15 @@ into their project's `.deepwork/jobs/` directory. research/ ├── AGENTS.md # This file ├── CLAUDE.md # Symlink to AGENTS.md -├── job.yml # Job definition with 4 workflows -├── readme.md # User-facing documentation -└── steps/ - ├── scope.md # Define research scope (shared: deep + quick) - ├── choose_platforms.md # Select AI platforms (deep only) - ├── gather.md # Gather sources, 8+ (deep) - ├── gather_quick.md # Gather sources, 3+ (quick) - ├── synthesize.md # Synthesize findings (deep) - ├── summarize.md # Synthesize + report in one step (quick) - ├── report.md # Write final report (deep) - ├── parse.md # Parse external material (ingest) - ├── file.md # File to notes directory (ingest) - ├── ingest_material.md # Nested ingest workflow entry (reproduce) - ├── analyze.md # Analyze reproducibility (reproduce) - └── plan.md # Create reproduction plan (reproduce) +├── job.yml # Job definition with 4 workflows (all step instructions inlined) +└── readme.md # User-facing documentation ``` ## Editing Guidelines - Source of truth is `library/jobs/research/` - Edit files here directly — changes benefit all adopters -- Step instruction files live in `steps/` and are referenced by `instructions_file` in job.yml +- Step instructions are inlined in job.yml ## Workflows diff --git a/src/deepwork/standard_jobs/deepwork_jobs/AGENTS.md b/src/deepwork/standard_jobs/deepwork_jobs/AGENTS.md index 83f7e191..2a44a027 100644 --- a/src/deepwork/standard_jobs/deepwork_jobs/AGENTS.md +++ b/src/deepwork/standard_jobs/deepwork_jobs/AGENTS.md @@ -22,13 +22,7 @@ deepwork_jobs/ ├── AGENTS.md # This file ├── job.yml # Job definition ├── make_new_job.sh # Script to create new job structure -├── steps/ -│ ├── define.md # Define step instructions -│ ├── implement.md # Implement step instructions -│ ├── test.md # Test step instructions -│ ├── iterate.md # Iterate step instructions -│ ├── learn.md # Learn step instructions -│ └── supplemental_file_references.md # Reference documentation +├── supplemental_file_references.md # Reference documentation for job.yml fields └── templates/ ├── job.yml.template # Job spec structure ├── step_instruction.md.template # Step instruction structure diff --git a/src/deepwork/standard_jobs/deepwork_jobs/job.yml b/src/deepwork/standard_jobs/deepwork_jobs/job.yml index 2ae2180f..99b90b76 100644 --- a/src/deepwork/standard_jobs/deepwork_jobs/job.yml +++ b/src/deepwork/standard_jobs/deepwork_jobs/job.yml @@ -92,7 +92,7 @@ workflows: ## Job Schema Reference - See `steps/supplemental_file_references.md` for available job.yml fields and structure. + See `supplemental_file_references.md` (relative to this job's directory) for available job.yml fields and structure. The JSON schema at `.deepwork/job.schema.json` documents the format — DeepSchema quality gates validate job.yml files automatically, so manual validation is not needed. steps: @@ -617,9 +617,9 @@ workflows: - List of all steps with their details - Understand the workflow structure - ### Step 2: Generate Step Instruction Files + ### Step 2: Write Inline Step Instructions - For each step in the job.yml, create a comprehensive instruction file at `[project_root]/.deepwork/jobs/[job_name]/steps/[step_name].md`. + For each step in the job.yml, write comprehensive inline instructions using the `instructions: |` YAML block scalar directly in the step definition. **Template reference**: See `/templates/step_instruction.md.template` for the standard structure. @@ -690,13 +690,11 @@ workflows: #### Using Supplementary Reference Files - Step instructions can include additional `.md` files in the `steps/` directory for detailed examples, templates, or reference material. Reference them using the full path from the project root. + Jobs can include additional `.md` files in the job directory for detailed examples, templates, or reference material. Reference them using the full path from the project root. ### Step 3: Verify Files - Verify that all files are in their correct locations: - - `job.yml` at `[project_root]/.deepwork/jobs/[job_name]/job.yml` (created by define step) - - Step instruction files at `[project_root]/.deepwork/jobs/[job_name]/steps/[step_name].md` + Verify that the job.yml is at `[project_root]/.deepwork/jobs/[job_name]/job.yml` and all steps have inline `instructions:` blocks. ## Example Implementation @@ -959,7 +957,7 @@ workflows: For each step that needs improvement: - 1. **Read the current instruction file** at `[project_root]/.deepwork/jobs/[job_name]/steps/[step_name].md` + 1. **Read the current inline instructions** for the step in `[project_root]/.deepwork/jobs/[job_name]/job.yml` 2. **Make targeted improvements**: - Add missing context or clarification @@ -1070,15 +1068,15 @@ workflows: ### Changes Made - **`.deepwork/jobs/monthly_report/steps/gather_data.md`:** + **`gather_data` step in `.deepwork/jobs/monthly_report/job.yml`:** - Added: "Use distinct, high-contrast colors for chart data series. Avoid similar shades for different categories." - Added to Quality Criteria: "Charts use visually distinct colors that are accessible to colorblind readers" - **`.deepwork/jobs/monthly_report/steps/analyze_trends.md`:** + **`analyze_trends` step in `.deepwork/jobs/monthly_report/job.yml`:** - Added: "Always include comparison to the same period in the previous month/quarter" - Added input: "previous_period_data" to formalize this requirement - **`.deepwork/jobs/monthly_report/steps/generate_report.md`:** + **`generate_report` step in `.deepwork/jobs/monthly_report/job.yml`:** - Added example of good executive summary targeting non-technical readers - Added: "Format tables with sufficient padding (at least 8px) and readable font size (minimum 11pt)" - Updated Quality Criteria: @@ -1133,7 +1131,7 @@ workflows: ## Job Schema Reference - See `steps/supplemental_file_references.md` for available job.yml fields and structure. + See `supplemental_file_references.md` (relative to this job's directory) for available job.yml fields and structure. The JSON schema at `.deepwork/job.schema.json` documents the format — DeepSchema quality gates validate job.yml files automatically, so manual validation is not needed. steps: @@ -1476,7 +1474,7 @@ workflows: 1. **Preserve custom logic** - When migrating, preserve the intent of instructions and reviews 2. **Test after changes** - Validate YAML syntax after each job fix to catch errors early 3. **Read step files** - When inlining instructions, read the full content of the referenced .md file - 4. **Delete orphaned step files** - After inlining all instructions into job.yml, delete the step .md files that were referenced by `instructions_file`. These are now dead weight since the content lives in job.yml. Do NOT delete step files that are still referenced by inline instructions as supplemental references. + 4. **Remove step instruction files** - After inlining all step instructions into job.yml, run `git rm` on the step instruction `.md` files that were referenced by `instructions_file` and remove the `steps/` directory entirely if it is now empty. These are dead weight since the content lives in job.yml. Do NOT delete files that are still referenced by inline instructions as supplemental references — move those to the job root directory instead. inputs: settings.json: required: true @@ -1490,7 +1488,7 @@ workflows: "No Legacy Fields": "No job.yml MAY contain version, root-level steps[], instructions_file, hooks, dependencies, or exposed/hidden fields." "Reviews Migrated": "Old review formats MUST be converted to output-level review blocks or process_requirements." "Instructions Inlined": "All step instructions MUST be inlined in the job.yml — no instructions_file references MAY remain." - "Orphaned Step Files Removed": "Step .md files that were referenced by `instructions_file` and have been inlined MUST be deleted from the steps/ directory." + "Orphaned Step Files Removed": "Step .md files that were referenced by `instructions_file` and have been inlined MUST be removed via `git rm`. The `steps/` directory MUST be removed if empty." "Jobs Parse Successfully": "Calling `get_workflows` MUST show all expected jobs without errors." - name: errata @@ -1698,7 +1696,7 @@ workflows: ## Job Schema Reference - See `steps/supplemental_file_references.md` for available job.yml fields and structure. + See `supplemental_file_references.md` (relative to this job's directory) for available job.yml fields and structure. The JSON schema at `.deepwork/job.schema.json` documents the format — DeepSchema quality gates validate job.yml files automatically, so manual validation is not needed. steps: @@ -1819,8 +1817,7 @@ workflows: For each generalizable learning: - 1. **Locate the instruction file** - - Path: `[project_root]/.deepwork/jobs/[job_name]/steps/[step_name].md` + 1. **Locate the step's inline instructions** in `[project_root]/.deepwork/jobs/[job_name]/job.yml` 2. **Make targeted improvements** - Add missing context or clarification @@ -1839,16 +1836,16 @@ workflows: - Add to appropriate sections rather than restructuring - Maintain consistency with other steps - ### Step 4b: Extract Shared Content into Referenced Files + ### Step 4b: Extract Shared Content - Review all instruction files for the job and identify content that: + Review all inline step instructions for the job and identify content that: - Appears in multiple step instructions (duplicated) - Is lengthy and could be extracted for clarity - Would benefit from being maintained in one place - **Extract to shared files:** + **Extract to shared files or `common_job_info_provided_to_all_steps_at_runtime`:** - 1. **Create shared files** in `[project_root]/.deepwork/jobs/[job_name]/steps/shared/` + 1. **Move duplicated content** to `common_job_info_provided_to_all_steps_at_runtime` in `job.yml` if it applies to all steps, or create shared `.md` files in the job directory root: - `conventions.md` - Coding/formatting conventions used across steps - `examples.md` - Common examples referenced by multiple steps - `schemas.md` - Data structures or formats used throughout @@ -1985,7 +1982,7 @@ workflows: **Actions Taken** - 1. Updated `.deepwork/jobs/competitive_research/steps/research_competitors.md`: + 1. Updated `research_competitors` step inline instructions in `.deepwork/jobs/competitive_research/job.yml`: - Added "Include pricing information (tiers, models, approximate ranges)" to research requirements - Added note about carrying forward industry context from previous step diff --git a/src/deepwork/standard_jobs/deepwork_jobs/steps/supplemental_file_references.md b/src/deepwork/standard_jobs/deepwork_jobs/supplemental_file_references.md similarity index 100% rename from src/deepwork/standard_jobs/deepwork_jobs/steps/supplemental_file_references.md rename to src/deepwork/standard_jobs/deepwork_jobs/supplemental_file_references.md diff --git a/src/deepwork/standard_jobs/deepwork_jobs/steps/sync_shared_jobs.md b/src/deepwork/standard_jobs/deepwork_jobs/sync_shared_jobs.md similarity index 100% rename from src/deepwork/standard_jobs/deepwork_jobs/steps/sync_shared_jobs.md rename to src/deepwork/standard_jobs/deepwork_jobs/sync_shared_jobs.md diff --git a/src/deepwork/standard_jobs/deepwork_jobs/template.deepreview b/src/deepwork/standard_jobs/deepwork_jobs/template.deepreview index 8da22cda..97ab8fd5 100644 --- a/src/deepwork/standard_jobs/deepwork_jobs/template.deepreview +++ b/src/deepwork/standard_jobs/deepwork_jobs/template.deepreview @@ -3,13 +3,11 @@ job_definition_review: match: include: - "job.yml" - - "steps/*.md" review: strategy: matches_together instructions: | - Review this DeepWork job definition (job.yml) and its step instruction files - (steps/*.md) holistically. Check that they form a coherent, well-structured - workflow that an AI agent can execute reliably. + Review this DeepWork job definition (job.yml) holistically. Check that it forms + a coherent, well-structured workflow that an AI agent can execute reliably. ## Reference Material @@ -41,13 +39,13 @@ job_definition_review: - Intermediate outputs that are not meant to be persisted should be in .deepwork/tmp (and the name should indicate that) - Final outputs follow project conventions (not hidden in dot-directories, descriptive names, appropriate use of subdirectories) - ### 4. Step Instructions Match job.yml - - Every step defined in job.yml has a corresponding instruction file + ### 4. Inline Step Instructions + - Every step defined in job.yml has inline `instructions:` content - Step instruction content aligns with the step's described purpose - Instructions reference the correct input and output filenames from job.yml - Instructions do not duplicate content already in `common_job_info_provided_to_all_steps_at_runtime` - - If there is duplicated content amongst the instruction files, it should be moved to `common_job_info_provided_to_all_steps_at_runtime` and removed from the instruction files - - If there is content that is needed in multiple steps but not all, it should be moved to its own file and referenced in the steps + - If there is duplicated content amongst step instructions, it should be moved to `common_job_info_provided_to_all_steps_at_runtime` + - If there is content that is needed in multiple steps but not all, it should be moved to a shared file in the job directory and referenced in the steps ### 5. Quality Reviews - Steps with complex or final outputs have reviews defined @@ -57,7 +55,7 @@ job_definition_review: - Steps with no meaningful quality checks use `reviews: []` ### 6. Step Instruction Quality - - Each instruction file has clear sections: Objective, Task/Process, + - Each step's inline instructions have clear sections: Objective, Task/Process, Output Format, and Quality Criteria - Instructions are specific and actionable, not generic placeholders - Output format sections show what good output looks like (examples or diff --git a/src/deepwork/standard_jobs/deepwork_reviews/steps/deepreview_reference.md b/src/deepwork/standard_jobs/deepwork_reviews/deepreview_reference.md similarity index 100% rename from src/deepwork/standard_jobs/deepwork_reviews/steps/deepreview_reference.md rename to src/deepwork/standard_jobs/deepwork_reviews/deepreview_reference.md diff --git a/src/deepwork/standard_jobs/deepwork_reviews/job.yml b/src/deepwork/standard_jobs/deepwork_reviews/job.yml index 580bc3f7..1f3c0a6f 100644 --- a/src/deepwork/standard_jobs/deepwork_reviews/job.yml +++ b/src/deepwork/standard_jobs/deepwork_reviews/job.yml @@ -39,7 +39,7 @@ workflows: patterns change in a PR or commit. For the .deepreview file format, key concepts, and rule naming conventions, read - `steps/deepreview_reference.md` (relative to this job's directory). + `deepreview_reference.md` (relative to this job's directory). steps: - name: add_deepwork_native_reviews instructions: | @@ -490,7 +490,7 @@ workflows: patterns change in a PR or commit. For the .deepreview file format, key concepts, and rule naming conventions, read - `steps/deepreview_reference.md` (relative to this job's directory). + `deepreview_reference.md` (relative to this job's directory). steps: - name: analyze_dependencies instructions: |