appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
33.13k stars 3.6k forks source link

Query Module flows exploration #24562

Closed ashit-rath closed 1 year ago

ashit-rath commented 1 year ago

During the User Flows Exploration phase, we delve into the detailed actions and interactions that users can perform within our platform. This phase focuses on conducting a comprehensive analysis to identify technical requirements, evaluate implementation feasibility, and address any existing technical debt.

The key engineering activities include:

User Flows Analysis: Examine each user flow and action, studying the underlying technical components and system behavior. This analysis helps us gain a deep understanding of how these flows can be integrated within our platform and align with our existing technical infrastructure.

Technical Debt Identification: As part of the User Flows Exploration phase, the existing codebase is examined to identify any technical debt. This involves pinpointing areas that require refactoring, optimization, or architectural improvements to enhance system stability, code maintainability, and overall performance.

POC Identification: In certain scenarios, we may want to develop POCs to validate specific technical approaches or assess the viability of integrating new technologies. These POCs are identified during the exploration of a flow and is added to the POC epic and is explored separately.

System Design Creation: We create a system design that represents the interaction of different components within the platform. This design showcases the architectural structure, component relationships, data flow, and key interfaces. It serves as a blueprint for subsequent development phases and ensures a coherent and scalable system.

Outcome

One of the 2 outcomes is expected from each task in this epic:

High level flow design and PoC to implement - A high level design of the idea that was explored and to validate the flow a POC is identified. The POC is added to the POC epic with detailed hypothesis and expected outcome from the POC. The POC when implemented would result to the success or failure of this hypothesis. If it's a success then a detailed spec can be drawn, if it is a failure then the new design can be drawn up to explore the user flow. or Detailed tech spec for the flow - If no POC is identified and the deep exploration was found to be enough to understand the flow then the outcome of this should be a detailed spec.

RACI

Responsible Accountable Consulted Informed
@ashit-rath @subrata71 @ApekshaBhosale @ashit-rath @riodeuno @nidhi-nair @somangshu
somangshu commented 1 year ago

@ashit-rath the outcome shows that we need either 1 of the 2. Does this mean, if we going for 1, the outcome of the subsequent POC (i.e. the EPIC) will be the tech spec?

subrata71 commented 1 year ago

Closing this epic as GAC was the only issue that remained blocked. As we got approval from Trisha with the mentioned approach, we can close this epic as well.

Ref