@codemcp/workflows-core 5.2.2 → 5.2.4

package/resources/workflows/minor.yaml

@@ -27,12 +27,21 @@ states:
   explore:
     description: 'Analysis and design phase - understanding and planning without implementation'
     default_instructions: >
-      You are in the exploration phase for minor enhancement.
-      This phase should be efficient since it's a minor enhancement.
       Understand the problem, analyze existing patterns, and design your approach.
-       Consider the scope and impact of the change. If $REQUIREMENTS_DOC exists, document requirements there, otherwise document them in your task management system. If $DESIGN_DOC exists, respect the design approach in $DESIGN_DOC.
-       Document your analysis and design decisions and create tasks as needed.
-      Focus on analysis and design only - do not write any code yet.
+      Consider the scope and impact of the change.
+
+      **STEP 1: Analyze Requirements**
+      - If `$REQUIREMENTS_DOC` exists: Use it to understand the required changes
+      - Otherwise: Document requirements in your task management system
+
+      **STEP 2: Review Design Approach**
+      - If `$DESIGN_DOC` exists: Respect the design approach documented in `$DESIGN_DOC`
+      - Otherwise: Design your approach based on the problem analysis
+
+      **STEP 3: Document Decisions**
+      - Document your analysis and design decisions
+      - Create tasks to guide implementation
+      - Focus on analysis and design only - do not write any code yet
     transitions:
       - trigger: 'exploration_complete'
         to: 'implement'
@@ -49,7 +58,22 @@ states:
 
   implement:
     description: 'Combined implementation phase - code, test, and commit'
-    default_instructions: "This phase combines coding, testing, and commit preparation. If $DESIGN_DOC exists, follow your design from $DESIGN_DOC. If $REQUIREMENTS_DOC exists, ensure the relevant requirements from $REQUIREMENTS_DOC are met, otherwise ensure existing requirements are met based on your task context. Write clean, focused code for the minor enhancement. Test your changes to ensure they work correctly and don't break existing functionality. Prepare documentation and commit when ready. Update task progress as needed."
+    default_instructions: >
+      Write clean, focused code for the minor enhancement, test your changes, and prepare for commit.
+
+      **STEP 1: Review Design and Requirements**
+      - If `$DESIGN_DOC` exists: Follow your design from `$DESIGN_DOC`
+      - Otherwise: Elaborate design options and present them to the user
+      - If `$REQUIREMENTS_DOC` exists: Ensure the relevant requirements from `$REQUIREMENTS_DOC` are met
+      - Otherwise: Ensure existing requirements are met based on your task context
+
+      **STEP 2: Implement Changes**
+      - Write clean, focused code for the minor enhancement
+      - Test your changes to ensure they work correctly and don't break existing functionality
+
+      **STEP 3: Prepare for Finalization**
+      - Update task progress as needed
+      - Prepare documentation and commit when ready
     transitions:
       - trigger: 'need_more_analysis'
         to: 'explore'
@@ -71,43 +95,42 @@ states:
   finalize:
     description: 'Code cleanup and documentation finalization'
     default_instructions: >
-      You are in the finalize phase. This phase ensures code quality and documentation accuracy through systematic cleanup and review.
+      Ensure code quality and documentation accuracy through systematic cleanup and review.
 
       **STEP 1: Code Cleanup**
       Systematically clean up development artifacts:
 
-      1. **Remove Debug Output**: Search for and remove all temporary debug output statements used during development.
-         Look for language-specific debug output methods (console logging, print statements, debug output functions).
-         Remove any debugging statements that were added for development purposes.
+      - **Remove Debug Output**: Search for and remove all temporary debug output statements used during development.
+        Look for language-specific debug output methods (console logging, print statements, debug output functions).
+        Remove any debugging statements that were added for development purposes.
 
-      2. **Review TODO/FIXME Comments**:
-         - Address each TODO/FIXME comment by either implementing the solution or documenting why it's deferred
-         - Remove completed TODOs
-         - Convert remaining TODOs to proper issue tracking if needed
+      - **Review TODO/FIXME Comments**:
+        - Address each TODO/FIXME comment by either implementing the solution or documenting why it's deferred
+        - Remove completed TODOs
+        - Convert remaining TODOs to proper issue tracking if needed
 
-      3. **Remove Debugging Code Blocks**:
-         - Remove temporary debugging code, test code blocks, and commented-out code
-         - Clean up any experimental code that's no longer needed
-         - Ensure proper error handling replaces temporary debug logging
+      - **Remove Debugging Code Blocks**:
+        - Remove temporary debugging code, test code blocks, and commented-out code
+        - Clean up any experimental code that's no longer needed
+        - Ensure proper error handling replaces temporary debug logging
 
       **STEP 2: Documentation Review**
       Review and update documentation to reflect final implementation:
 
-       1. **Update Long-Term Memory Documents**: Based on what was actually implemented:
-          • If $REQUIREMENTS_DOC exists, update $REQUIREMENTS_DOC if requirements changed during development
-          • If $DESIGN_DOC exists, update $DESIGN_DOC if design details were refined or changed
-      2. **Compare Against Implementation**: Review documentation against actual implemented functionality
-      3. **Update Changed Sections**: Only modify documentation sections that have functional changes
-      4. **Remove Development Progress**: Remove references to development iterations, progress notes, and temporary decisions
-      5. **Focus on Final State**: Ensure documentation describes the final implemented state, not the development process
-      6. **Ask User to Review Document Updates**
+      - **Update Long-Term Memory Documents**: Based on what was actually implemented:
+        - If `$REQUIREMENTS_DOC` exists: Update `$REQUIREMENTS_DOC` if requirements changed during development
+        - If `$DESIGN_DOC` exists: Update `$DESIGN_DOC` if design details were refined or changed
+      - **Compare Against Implementation**: Review documentation against actual implemented functionality
+      - **Update Changed Sections**: Only modify documentation sections that have functional changes
+      - **Remove Development Progress**: Remove references to development iterations, progress notes, and temporary decisions
+      - **Focus on Final State**: Ensure documentation describes the final implemented state, not the development process
+      - **Ask User to Review Document Updates**
 
       **STEP 3: Final Validation**
       - Run existing tests to ensure cleanup didn't break functionality
       - Verify documentation accuracy with a final review
       - Ensure minor enhancement is ready for delivery
-
-       Update task progress and mark completed work as you finalize the minor enhancement.
+      - Update task progress and mark completed work as you finalize the minor enhancement
     transitions:
       - trigger: 'need_implementation_changes'
         to: 'implement'

package/resources/workflows/posts.yaml

@@ -24,18 +24,21 @@ states:
   discovery:
     description: 'Research topic, decide format, and analyze competitive landscape'
     default_instructions: |
-      You are in the discovery phase for post development. This is where you define the foundation of your post.
+      Define the foundation of your post by establishing topic understanding and format.
+
+      Determine post format by asking about:
+      - Goal (quick insight vs deep exploration)
+      - Topic complexity level
+      - Available time for development
 
-      Focus on understanding the topic and format:
-      - Help user decide post format: Ask about goal (quick insight vs deep exploration), topic complexity, available time
       - Research existing content on this topic to identify gaps and opportunities
       - Guide user to articulate personal motivation and unique angle
       - Conduct competitive landscape analysis to avoid duplication
       - Define target audience and platform considerations
       - Gather initial sources and reference materials
 
-      Work with the user to establish clear direction before moving to story development.
-      Update the plan file with discovery progress and key decisions.
+      Establish clear direction before moving to story development.
+      Update `$PLAN_FILE` with discovery progress and key decisions.
 
     transitions:
       - trigger: discovery_complete
@@ -45,17 +48,16 @@ states:
       - trigger: abandon_post
         to: discovery
         instructions: |
-          Post development abandoned. Clean up any discovery work and prepare for new post topics.
-          The plan file will remain for future reference if needed.
-        additional_instructions: 'Post development abandoned. Prepare for new post topics.'
+          Abandon post development. Clean up any discovery work and prepare for new post topics.
+          The `$PLAN_FILE` will remain for future reference if needed.
+        additional_instructions: 'Prepare for new post topics.'
         transition_reason: 'User decided to abandon current post development'
 
   story:
     description: 'Create narrative structure and story outline'
     default_instructions: |
-      Working on story development phase. Focus on creating a compelling narrative structure.
+      Create a compelling narrative structure for your post.
 
-      Key activities for this phase:
       - Create detailed story outline with clear beginning, middle, end
       - Identify key messages and memorable metaphors/examples
       - Define content scope boundaries to maintain focus and avoid adjacent topics
@@ -63,8 +65,8 @@ states:
       - Ensure narrative arc matches chosen format (concise for short posts, comprehensive for long-form)
       - Structure content to maintain user's personal voice and conversational style
 
-      Work with the user to create a solid story foundation before moving to writing.
-      Update the plan file with story decisions and structural progress.
+      Build a solid story foundation before moving to writing.
+      Update `$PLAN_FILE` with story decisions and structural progress.
 
     transitions:
       - trigger: story_complete
@@ -72,28 +74,27 @@ states:
         additional_instructions: |
           Story complete! ✅ You have a clear narrative structure and content outline.
 
-          Update the plan file with writing tasks and mark completed story work.
+          Update `$PLAN_FILE` with writing tasks and mark completed story work.
         transition_reason: 'Story structure and outline complete, ready for content creation'
 
       - trigger: need_more_discovery
         to: discovery
-        additional_instructions: 'Story development revealed gaps in research or format clarity. Focus on clarifying these foundational aspects.'
+        additional_instructions: 'Resolve gaps in research or format clarity by focusing on foundational aspects.'
         transition_reason: 'Story work revealed need for additional discovery or research'
 
       - trigger: abandon_post
         to: discovery
         instructions: |
-          Post development abandoned during story phase. Clean up story work and return to discovery.
-          The plan file and any completed work will remain for future reference.
-        additional_instructions: 'Post abandoned during story phase. Clean up and prepare for new topics.'
+          Abandon post development during story phase. Clean up story work and return to discovery.
+          The `$PLAN_FILE` and any completed work will remain for future reference.
+        additional_instructions: 'Clean up and prepare for new topics.'
         transition_reason: 'User decided to abandon post during story phase'
 
   writing:
     description: 'Create the actual post content following story outline'
     default_instructions: |
-      Working on writing phase. Focus purely on creating engaging content.
+      Create engaging content following the established story outline.
 
-      Key activities for this phase:
       - Write content following the established story outline
       - Maintain consistent narrative flow and personal voice
       - Create engaging, conversational content in user's style
@@ -103,7 +104,7 @@ states:
       - Create clear section structure with appropriate headings (for long-form)
 
       Focus on high-quality content creation without visual elements.
-      Update the plan file with writing progress and content decisions.
+      Update `$PLAN_FILE` with writing progress and content decisions.
 
     transitions:
       - trigger: writing_complete
@@ -111,28 +112,27 @@ states:
         additional_instructions: |
           Writing complete! ✅ You have solid content that follows your story outline.
 
-          Update the plan file with illustration tasks and mark completed writing work.
+          Update `$PLAN_FILE` with illustration tasks and mark completed writing work.
         transition_reason: 'Content creation complete, ready for visual enhancement'
 
       - trigger: need_story_revision
         to: story
-        additional_instructions: 'Writing revealed issues with story structure or narrative flow. Focus on refining the story foundation.'
+        additional_instructions: 'Refine the story foundation to address issues with structure or narrative flow.'
         transition_reason: 'Content creation revealed need for story structure refinement'
 
       - trigger: abandon_post
         to: discovery
         instructions: |
-          Post development abandoned during writing. Clean up writing work and return to discovery.
-          The plan file and any completed work will remain for future reference.
-        additional_instructions: 'Post abandoned during writing phase. Clean up and prepare for new topics.'
+          Abandon post development during writing. Clean up writing work and return to discovery.
+          The `$PLAN_FILE` and any completed work will remain for future reference.
+        additional_instructions: 'Clean up and prepare for new topics.'
         transition_reason: 'User decided to abandon post during writing phase'
 
   illustration:
     description: 'Create and integrate visual elements'
     default_instructions: |
-      Working on illustration phase. Focus on visual enhancement of your content.
+      Enhance your content with visual elements.
 
-      Key activities for this phase:
       - Identify strategic locations for visual elements
       - Create or source appropriate visuals (screenshots, diagrams, metaphorical images)
       - Ensure visual density matches format (minimal for short posts, comprehensive for long-form)
@@ -141,8 +141,8 @@ states:
       - Consider accessibility and platform compatibility
       - Plan visual integration and placement
 
-      Focus on creating visuals that enhance rather than distract from the content.
-      Update the plan file with illustration progress and visual decisions.
+      Create visuals that enhance rather than distract from the content.
+      Update `$PLAN_FILE` with illustration progress and visual decisions.
 
     transitions:
       - trigger: illustration_complete
@@ -150,28 +150,27 @@ states:
         additional_instructions: |
           Illustration complete! ✅ You have visually enhanced content ready for publishing.
 
-          Update the plan file with distribution tasks and mark completed illustration work.
+          Update `$PLAN_FILE` with distribution tasks and mark completed illustration work.
         transition_reason: 'Visual elements complete, ready for SEO optimization and publishing'
 
       - trigger: need_more_content
         to: writing
-        additional_instructions: 'Illustration work revealed gaps in written content. Focus on completing the content foundation.'
+        additional_instructions: 'Complete the content foundation to address gaps revealed during visual work.'
         transition_reason: 'Visual work revealed need for additional written content'
 
       - trigger: abandon_post
         to: discovery
         instructions: |
-          Post development abandoned during illustration. Clean up illustration work and return to discovery.
-          The plan file and any completed work will remain for future reference.
-        additional_instructions: 'Post abandoned during illustration phase. Clean up and prepare for new topics.'
+          Abandon post development during illustration. Clean up illustration work and return to discovery.
+          The `$PLAN_FILE` and any completed work will remain for future reference.
+        additional_instructions: 'Clean up and prepare for new topics.'
         transition_reason: 'User decided to abandon post during illustration phase'
 
   distribution:
     description: 'Optimize for SEO and publish across platforms'
     default_instructions: |
-      Working on distribution phase. Focus on optimization and multi-platform publishing.
+      Optimize content and publish across multiple platforms.
 
-      Key activities for this phase:
       - Create compelling, SEO-optimized titles and descriptions
       - Add appropriate tags and metadata for discoverability
       - Adapt content formatting for different platforms (LinkedIn, Medium, HN)
@@ -180,8 +179,8 @@ states:
       - Prepare publishing materials and schedule
       - Execute multi-platform publishing strategy
 
-      Focus on maximizing reach while maintaining content quality and consistency.
-      Update the plan file with distribution progress and publishing decisions.
+      Maximize reach while maintaining content quality and consistency.
+      Update `$PLAN_FILE` with distribution progress and publishing decisions.
 
     transitions:
       - trigger: distribution_complete
@@ -190,13 +189,13 @@ states:
 
       - trigger: need_final_review
         to: illustration
-        additional_instructions: 'Distribution preparation revealed issues with visuals or content presentation. Focus on final refinements.'
+        additional_instructions: 'Refine visuals or content presentation based on issues identified during publishing preparation.'
         transition_reason: 'Publishing preparation identified issues requiring visual or content refinement'
 
       - trigger: abandon_post
         to: discovery
         instructions: |
-          Post development abandoned before distribution. Clean up distribution preparation and return to discovery.
-          The plan file and completed work will remain for future reference.
-        additional_instructions: 'Post abandoned before distribution. Clean up and prepare for new topics.'
+          Abandon post development before distribution. Clean up distribution preparation and return to discovery.
+          The `$PLAN_FILE` and completed work will remain for future reference.
+        additional_instructions: 'Clean up and prepare for new topics.'
         transition_reason: 'User decided to abandon post before distribution'