PAELLADOC

{ "flow_id": "main_conversation", "name": "PAELLADOC Main Conversation", "description": "Main conversation flow for all PAELLADOC commands", "required": true, "priority": "critical", "trigger_commands": ["PAELLA", "CONTINUE", "GENERATE_CODE"], "presentation": { "introduction": "Welcome to PAELLADOC. I'll ask you questions ONE BY ONE to gather information about your project. After each response, I'll save the information to the project memory, and only when we have all the necessary information, I'll show you a summary and ask if you want to generate the documentation.", "outro": "Thank you for providing this information. Remember you can use commands like MEMORY to view the project record, or ACHIEVEMENT, ISSUE, or DECISION to record important events." }, "steps": [ { "id": "project_basics", "name": "Project Basic Information", "description": "Collect basic information about the project to document", "required": true, "sequential": true, "save_to_memory_after_each_question": true, "questions": [ { "id": "project_name", "text": "What is the name of the project?", "type": "text", "default": null, "required": true, "memory_path": "project.name", "confirmation_message": "Saved: Project name = '{{value}}'" }, { "id": "project_description", "text": "Provide a brief description of the project:", "type": "textarea", "default": null, "required": true, "memory_path": "project.description", "confirmation_message": "Saved: Project description" }, { "id": "project_purpose", "text": "What is the main purpose of the project?", "type": "textarea", "default": null, "required": true, "memory_path": "project.purpose", "confirmation_message": "Saved: Project purpose" } ] }, { "id": "documentation_scope", "name": "Documentation Scope", "description": "Determine the scope and depth of the documentation", "required": true, "sequential": true, "save_to_memory_after_each_question": true, "questions": [ { "id": "documentation_depth", "text": "What level of detail should the documentation have?", "type": "single_choice", "options": [ "Minimal - just the essentials, very simple structure", "Basic - only essential aspects", "Standard - complete but concise documentation", "Detailed - thorough documentation with examples", "Exhaustive - complete documentation for all aspects" ], "default": "Standard - complete but concise documentation", "required": true, "memory_path": "documentation.depth", "confirmation_message": "Saved: Documentation level of detail = '{{value}}'" }, { "id": "documentation_priorities", "text": "Which areas are priorities in the documentation?", "type": "multiple_choice", "options": [ "Technical architecture", "APIs and interfaces", "User flows", "Configuration and deployment", "Security", "Testing", "Development guides", "User guides" ], "default": [], "required": true, "memory_path": "documentation.priorities", "confirmation_message": "Saved: Documentation priorities" }, { "id": "existing_documentation", "text": "Is there any existing documentation that should be incorporated?", "type": "boolean", "default": false, "required": true, "memory_path": "documentation.has_existing", "confirmation_message": "Saved: Existing documentation = {{value}}" }, { "id": "existing_documentation_details", "text": "Describe the existing documentation:", "type": "textarea", "condition": { "field": "existing_documentation", "value": true }, "required": true, "memory_path": "documentation.existing_details", "confirmation_message": "Saved: Existing documentation details" } ] }, { "id": "project_category", "name": "Project Category", "description": "Determine the category and type of the project", "required": true, "sequential": true, "save_to_memory_after_each_question": true, "questions": [ { "id": "project_category", "text": "What category does this project belong to?", "type": "single_choice", "options": [ "Web", "Mobile", "Desktop", "Extension/Plugin", "API/Backend", "Library/Framework", "Command Line Tool", "Game", "IoT/Embedded", "Other" ], "default": null, "required": true, "memory_path": "project.category", "confirmation_message": "Saved: Project category = '{{value}}'" }, { "id": "project_category_other", "text": "Please specify the project category:", "type": "text", "condition": { "field": "project_category", "value": "Other" }, "required": true, "memory_path": "project.category_custom", "confirmation_message": "Saved: Custom category = '{{value}}'" } ] }, { "id": "development_methodology", "name": "Development Methodology", "description": "Collect information about development methodologies", "required": true, "sequential": true, "save_to_memory_after_each_question": true, "questions": [ { "id": "methodologies", "text": "What development methodologies will be applied?", "type": "multiple_choice", "options": [ "Test-Driven Development (TDD)", "Behavior-Driven Development (BDD)", "Agile/Scrum", "DevOps/CI", "Pair Programming", "No specific methodology" ], "default": [], "required": true, "memory_path": "development.methodologies", "confirmation_message": "Saved: Development methodologies" } ] }, { "id": "requirements_summary", "name": "Requirements Summary", "description": "Show a summary of all collected information", "required": true, "no_questions": true, "message": "## Project Requirements Summary\n\n### Basic Information\n- Project name: {{project_name}}\n- Category: {{project_category}}\n- Purpose: {{project_purpose}}\n\n### Documentation Scope\n- Level of detail: {{documentation_depth}}\n- Priorities: {{documentation_priorities}}\n\n### Development Methodology\n- Methodologies: {{methodologies}}\n\nLet's review this information to ensure it's complete and correct." }, { "id": "user_confirmation", "name": "Confirmation", "description": "Confirm document generation", "required": true, "questions": [ { "id": "confirm_generation", "text": "Do you want to generate the documentation with the provided information?\n\nIf you confirm, documentation files will be created according to the defined structure.", "type": "boolean", "default": false, "required": true, "memory_path": "documentation.confirmed_generation" } ] }, { "id": "next_steps", "name": "Next Steps", "description": "Guidance on how to continue with the documentation process", "required": true, "condition": { "field": "confirm_generation", "value": true }, "no_questions": true, "message": "Excellent! I'll generate the documentation structure for your '{{project_name}}' project based on your requirements.\n\nTo continue working with this documentation, you can use:\n\n- `CONTINUE project_name=\"{{project_name}}\"` to resume this project later\n- `MEMORY` to view the project record\n- `ACHIEVEMENT`, `ISSUE` or `DECISION` to record important events" }, { "id": "canceled_generation", "name": "Canceled Generation", "description": "Message when generation is canceled", "required": true, "condition": { "field": "confirm_generation", "value": false }, "no_questions": true, "message": "No problem. Documentation generation has been canceled. All the information provided has been saved in the project memory. You can use the PAELLA command to resume the process when you're ready, or provide additional parameters to customize the documentation." } ], "generation_control": { "enable_generation": "{{confirm_generation}}", "generation_message": "Generating documentation for project '{{project_name}}' with '{{documentation_depth}}' level of detail...", "manual_generation_only": true, "memory_update_on_generation": true }, "output_templates": [ { "template_id": "project_definition_md", "format": "markdown", "path": "docs/{{project_name}}/definition/project_definition.md", "template_file": ".cursor/rules/templates/Product/01_project_definition.md", "condition": { "field": "confirm_generation", "value": true } }, { "template_id": "memory_json", "format": "json", "path": "docs/{{project_name}}/.memory.json", "template_file": ".cursor/rules/templates/Product/memory_template.json", "condition": { "field": "confirm_generation", "value": true } } ] }