@codemcp/workflows 5.3.0 → 6.0.2

package/packages/core/resources/workflows/minor.yaml

@@ -0,0 +1,138 @@
+# yaml-language-server: $schema=../state-machine-schema.json
+---
+name: 'minor'
+description: 'A streamlined workflow for small-impact changes: Explore (analysis + design) → Implement (code + test + commit) - optimized for minor enhancements'
+initial_state: 'explore'
+
+# Enhanced metadata for better discoverability
+metadata:
+  domain: 'code'
+  complexity: 'low'
+  bestFor:
+    - 'Small bug fixes'
+    - 'Minor feature enhancements'
+    - 'Code refactoring'
+    - 'Documentation updates'
+  useCases:
+    - 'Adding a new parameter to an existing function'
+    - 'Improving error messages'
+    - 'Small UI adjustments'
+  examples:
+    - 'Fix a typo in user interface text'
+    - 'Add validation to an input field'
+    - 'Enhance logging in a specific module'
+
+# States with default instructions and transitions
+states:
+  explore:
+    description: 'Analysis and design phase - understanding and planning without implementation'
+    default_instructions: >
+      Understand the problem, analyze existing patterns, and design your approach.
+      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'
+        transition_reason: 'Analysis and design complete, ready for streamlined implementation'
+
+  implement:
+    description: 'Combined implementation phase - code, test, and commit'
+    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'
+        additional_instructions: 'Implementation revealed gaps in analysis or design. Focus on the specific areas that need clarification before continuing with implementation.'
+        transition_reason: 'Implementation work revealed need for more analysis or design'
+
+      - trigger: 'implementation_complete'
+        to: 'finalize'
+        transition_reason: 'Implementation complete, ready for finalization'
+
+      - trigger: 'abandon_feature'
+        to: 'explore'
+        instructions: >
+          Minor enhancement abandoned during implementation. Clean up any incomplete code and return to exploration.
+          Task history and any completed work will remain for future reference.
+        additional_instructions: 'Clean up any incomplete code and prepare for new tasks.'
+        transition_reason: 'User decided to abandon minor enhancement during implementation'
+
+  finalize:
+    description: 'Code cleanup and documentation finalization'
+    default_instructions: >
+      Ensure code quality and documentation accuracy through systematic cleanup and review.
+
+      **STEP 1: Code Cleanup**
+      Systematically clean up development artifacts:
+
+      - **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.
+
+      - **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
+
+      - **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:
+
+      - **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
+    transitions:
+      - trigger: 'need_implementation_changes'
+        to: 'implement'
+        additional_instructions: 'Finalization revealed issues that require implementation changes. Focus on the specific problems identified during final review.'
+        transition_reason: 'Finalization revealed issues requiring implementation changes'
+
+      - trigger: 'finalization_complete'
+        to: 'explore'
+        transition_reason: 'Minor enhancement delivery complete, ready for next task'
+
+      - trigger: 'abandon_feature'
+        to: 'explore'
+        additional_instructions: 'Clean up any finalization artifacts and prepare for new tasks.'
+        transition_reason: 'User decided to abandon minor enhancement during finalization'

package/packages/core/resources/workflows/posts.yaml

@@ -0,0 +1,193 @@
+name: posts
+description: 'A comprehensive workflow for writing posts - from blog posts to short-form content, with research, story development, and multi-platform publishing'
+initial_state: discovery
+
+# Enhanced metadata for better discoverability
+metadata:
+  domain: 'office'
+  complexity: 'medium'
+  bestFor:
+    - 'Blog post writing'
+    - 'Content creation'
+    - 'Article development'
+    - 'Social media content'
+  useCases:
+    - 'Writing technical blog posts'
+    - 'Creating marketing content'
+    - 'Developing thought leadership articles'
+  examples:
+    - 'Write a tutorial blog post'
+    - 'Create a product announcement'
+    - 'Develop a technical deep-dive article'
+
+states:
+  discovery:
+    description: 'Research topic, decide format, and analyze competitive landscape'
+    default_instructions: |
+      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
+
+      - 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
+
+      Establish clear direction before moving to story development.
+      Update `$PLAN_FILE` with discovery progress and key decisions.
+
+    transitions:
+      - trigger: discovery_complete
+        to: story
+        transition_reason: 'Topic researched and format decided, ready for story structure development'
+
+  story:
+    description: 'Create narrative structure and story outline'
+    default_instructions: |
+      Create a compelling narrative structure for your post.
+
+      - 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
+      - Plan how content will adapt across different platforms
+      - 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
+
+      Build a solid story foundation before moving to writing.
+      Update `$PLAN_FILE` with story decisions and structural progress.
+
+    transitions:
+      - trigger: story_complete
+        to: writing
+        additional_instructions: |
+          Story complete! ✅ You have a clear narrative structure and content outline.
+
+          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: '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: |
+          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: |
+      Create engaging content following the established story outline.
+
+      - Write content following the established story outline
+      - Maintain consistent narrative flow and personal voice
+      - Create engaging, conversational content in user's style
+      - Ensure content length matches chosen format (3-10 lines for short, 2000-5000+ words for long)
+      - Stay within defined content scope to avoid adjacent topics
+      - Include concrete examples and metaphors as planned
+      - Create clear section structure with appropriate headings (for long-form)
+
+      Focus on high-quality content creation without visual elements.
+      Update `$PLAN_FILE` with writing progress and content decisions.
+
+    transitions:
+      - trigger: writing_complete
+        to: illustration
+        additional_instructions: |
+          Writing complete! ✅ You have solid content that follows your story outline.
+
+          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: '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: |
+          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: |
+      Enhance your content with visual elements.
+
+      - 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)
+      - Maintain visual consistency and professional appearance
+      - Ensure visuals support and enhance the written content
+      - Consider accessibility and platform compatibility
+      - Plan visual integration and placement
+
+      Create visuals that enhance rather than distract from the content.
+      Update `$PLAN_FILE` with illustration progress and visual decisions.
+
+    transitions:
+      - trigger: illustration_complete
+        to: distribution
+        additional_instructions: |
+          Illustration complete! ✅ You have visually enhanced content ready for publishing.
+
+          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: '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: |
+          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: |
+      Optimize content and publish across multiple platforms.
+
+      - Create compelling, SEO-optimized titles and descriptions
+      - Add appropriate tags and metadata for discoverability
+      - Adapt content formatting for different platforms (LinkedIn, Medium, HN)
+      - Maintain core message while adjusting for platform-specific requirements
+      - Conduct final quality review and polish
+      - Prepare publishing materials and schedule
+      - Execute multi-platform publishing strategy
+
+      Maximize reach while maintaining content quality and consistency.
+      Update `$PLAN_FILE` with distribution progress and publishing decisions.
+
+    transitions:
+      - trigger: distribution_complete
+        to: discovery
+        transition_reason: 'Post publishing completed successfully, ready for new projects'
+
+      - trigger: need_final_review
+        to: illustration
+        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: |
+          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'