└── README.md /README.md: -------------------------------------------------------------------------------- 1 | 2 | # **UltiPrompting: Advanced Prompting Framework for Fullstack Applications** 3 | 4 | **UltiPrompting** combines cutting-edge techniques in prompt engineering with an easy-to-use, modular approach for creating fully functional fullstack applications. This README provides clear, step-by-step instructions to guide the development process. 5 | 6 | --- 7 | 8 | ## **How to Use the UltiPrompting Framework** 9 | 10 | Follow these steps sequentially to create and refine a fullstack application: 11 | 12 | --- 13 | 14 | ### **Step 1: Start with Documentation Creation** 15 | 16 | The foundation of any project begins with strong documentation. 17 | 18 | #### **Prompt** 19 | ```plaintext 20 | Create complete project documentation. Follow these steps: 21 | 22 | ### Step 1: Gather Information 23 | 1. Ask detailed questions to collect all necessary information: 24 | - What is the product’s name and purpose? 25 | - Who is the target audience? 26 | - What are the must-have features? 27 | 28 | ### Step 2: Build Documentation Files 29 | 1. Create or update the following files: 30 | - `/docs/overview.md`: Project goals, target audience, and key value. 31 | - `/docs/features.md`: Detailed feature list with dependencies and scenarios. 32 | - `/docs/system_architecture.md`: Diagrams and communication flows. 33 | - `/docs/agents.md`: Detailed descriptions of each agent’s purpose, functionality, and specific tasks. 34 | ```plaintext 35 | ## Example Agent Entry 36 | ### MVP Agent 37 | Purpose: Build a browser-testable Minimum Viable Product. 38 | Triggers: Missing or incomplete core features. 39 | Workflow: 40 | - Identify and implement essential features. 41 | - Test functionality in a browser environment. 42 | - Log outcomes in `/docs/progress_X.md`. 43 | 44 | ### Testing Agent 45 | Purpose: Validate the robustness of the application. 46 | Triggers: New features added or bugs identified. 47 | Workflow: 48 | - Create and execute unit, integration, and end-to-end tests. 49 | - Log test results and gaps in `/docs/progress_X.md`. 50 | - Propose fixes for failures. 51 | 52 | ### Design Agent 53 | Purpose: Refine system architecture and user experience. 54 | Triggers: Need for optimization or design updates. 55 | Workflow: 56 | - Propose architectural improvements. 57 | - Create or update design diagrams in `/docs/system_architecture.md`. 58 | - Ensure compatibility with existing features. 59 | ``` 60 | 2. Validate the initial documentation for completeness and alignment with project goals. 61 | ``` 62 | 63 | --- 64 | 65 | ### **Step 2: Progress Documentation Management** 66 | 67 | Keep track of development progress with detailed logs. 68 | 69 | #### **Prompt** 70 | ```plaintext 71 | Manage progress documentation dynamically. Follow these steps: 72 | 73 | ### Step 1: Check Existing Progress Logs 74 | 1. Scan the `/docs/` directory for the latest progress file (e.g., `progress_X.md`). 75 | - If no progress file exists, create `/docs/progress_1.md`. 76 | - Use the highest-indexed file for ongoing work. 77 | 78 | ### Step 2: Log Development Activities 79 | 1. Update the current progress file with: 80 | - Tasks completed. 81 | - Challenges or blockers encountered. 82 | - Next steps or proposed tasks. 83 | 84 | ### Step 3: Archive and Create New Logs 85 | 1. At the end of an iteration: 86 | - Rename the current file as archived (e.g., `/docs/progress_X_archived.md`). Use a clear naming convention such as including the date or task in the filename (e.g., `/docs/progress_2023-12-01_archived.md`). 87 | - Create a new progress file incrementing the index (e.g., `/docs/progress_X+1.md`) to maintain clarity and organization. 88 | ``` 89 | 90 | --- 91 | 92 | ### **Step 3: Iterate and Execute Tasks Dynamically** 93 | 94 | This step replaces the need for a separate agent selection step by integrating both agent selection and task execution into a single prompt. 95 | 96 | #### **Prompt** 97 | ```plaintext 98 | Iteratively refine the application and execute tasks dynamically. Follow these steps: 99 | 100 | ### Step 1: Retrieve Context 101 | 1. Open `/docs/progress_X.md` to review and explicitly fetch the following data: 102 | - Tasks completed in the last iteration. 103 | - Pending tasks or blockers. 104 | - Proposed next steps. 105 | Ensure the AI reads and interprets the data directly from the file to maintain continuity and avoid context loss. 106 | 2. Cross-reference `/docs/agents.md` to determine the relevant agent: 107 | - Identify the agent whose triggers match the current progress log. Ensure that workflows in `/docs/agents.md` are detailed enough to handle complex tasks or dependencies, including edge cases and multi-step processes. 108 | - Retrieve the agent’s workflow for execution, and validate it against the current project requirements. 109 | 110 | ### Step 2: Execute the Task 111 | 1. Follow the workflow for the selected agent: 112 | - For MVP Agent: Implement core features and test them in a browser. 113 | - For Testing Agent: Write and execute tests, then document results. 114 | - For Design Agent: Refine architecture diagrams and ensure compatibility. 115 | 2. Ensure tasks adhere to best practices: 116 | - Modular, scalable, and maintainable code. 117 | - Validated outputs with tests and reviews. 118 | - Include manual validation steps to confirm the tasks meet project goals and align with the expected outcomes beyond automated testing. 119 | 120 | ### Step 3: Log Progress and Propose Next Steps 121 | 1. Update `/docs/progress_X.md` with: 122 | - Tasks completed and their outcomes. 123 | - Challenges encountered and how they were resolved. 124 | - Next steps or recommendations for the following iteration. 125 | ``` 126 | 127 | --- 128 | 129 | ## **How the Prompts Work Together to Create Fullstack Applications** 130 | 131 | The UltiPrompting framework is designed to guide you step-by-step through the development process of a fullstack application. Here’s how the prompts interact to deliver results: 132 | 133 | 1. **Documentation Creation (Step 1)**: 134 | - Establishes the foundation by defining the product, its features, and the technical requirements. 135 | - Creates `/docs/agents.md`, detailing the role of each agent, triggers, and workflows. 136 | 137 | 2. **Progress Documentation Management (Step 2)**: 138 | - Keeps an ongoing log of actions, ensuring clarity and traceability. 139 | - Enables agents to dynamically manage tasks without duplication. 140 | 141 | 3. **Iterative Execution and Refinement (Step 3)**: 142 | - Dynamically selects the appropriate agent based on `/docs/progress_X.md` and `/docs/agents.md`. 143 | - Executes workflows specific to the agent (e.g., MVP creation, testing, or design refinement). 144 | - Logs progress and proposes next steps for iterative improvement. 145 | 146 | ### **Using the Prompts to Develop Fullstack Applications** 147 | 148 | #### **Step 1: Start with Documentation** 149 | - Begin by creating the foundational documentation for your project. 150 | - Use the **Step 1 Prompt** to generate `/docs/overview.md`, `/docs/features.md`, `/docs/system_architecture.md`, and `/docs/agents.md`. 151 | 152 | #### **Step 2: Manage Progress** 153 | - Use the **Step 2 Prompt** to keep your progress logs organized and up-to-date. 154 | - Ensure that all completed tasks, blockers, and next steps are recorded in `/docs/progress_X.md`. 155 | 156 | #### **Step 3: Execute and Iterate** 157 | - Use the **Step 3 Prompt** repeatedly to: 158 | - Retrieve context dynamically from the documentation. 159 | - Select the relevant agent and execute its workflow. 160 | - Log all progress and refine the application iteratively. 161 | 162 | By following these steps, you can efficiently create, test, and refine a fullstack application while maintaining clarity and structure throughout the development lifecycle. 163 | 164 | --- 165 | 166 | ## **License** 167 | 168 | This project is licensed under the [MIT License](LICENSE). 169 | --------------------------------------------------------------------------------