Design Studio: Difference between revisions

Latest revision as of 14:21, 31 October 2024

Table of Contents
Getting Started	Ideation Studio	Design Studio	Build Studio	FAQs

Design Studio

Introduction

Design Studio enables you to select and configure the modules and pages that best align with your project's needs. You can also upload your own logo, choose a layout, and select a color palette to match your branding. Xami, the AI Advisor, will assist in generating pages and seamlessly integrating your logo throughout each one.

Design Studio, which includes Xami, assists users in creating comprehensive user stories with tailored recommendations for different user roles in the project. Once the solution is complete, users can add on features like annual maintenance, VAPT (Vulnerability Assessment and Penetration Testing), and contingency planning to ensure it's secure and comprehensive. For a scalable and reliable infrastructure, an additional option of cloud hosting is available.

Users can make the most of Design Studio’s features to develop a comprehensive, customized solution that satisfies the demands of their project.

Updated on: 10/23/2024

Project Hub

Navigate the Project Hub

The Project Hub serves as the central place for managing and monitoring your projects and accessing the essential tools and resources required. Follow these steps to navigate it.

1. After signing in, the Project Hub is your landing page. Alternatively, access it from the dropdown next to your registered email.

2. Click ‘Project Hub’ to be directed to the page.

3. In the Project Hub, all projects where you are a member or involved in are displayed.

4. Each project is presented as a card with key details such as the project name, estimated cost, platform version, and current state, among others.

5. Use the navigation bar to search for a specific project.

6. Browse through the sections based on the project's current state such as: Draft, Prepared, Contracting, Build, Unpaid, Shared, Closed, and Archived.

Reference Material

Feature	Description
Show All	• Displays all active projects you are a member of.
Draft	• If project is incomplete and still in progress.
Prepared	• If project is ready for a proposal request.
Contracting	• If project’s proposal is in negotiation or agreed upon.
Build	• If project is in the development phase.
Unpaid	• If project’s payment is pending.
Shared	• If project is shared for collaboration.
Closed	• If project activities are finalized.
Archived	• If project is inactive and stored for future reference.

Updated on: 10/23/2024

Managing Projects

This involves overseeing and managing the project’s progress and utilizing available tools in the Project Hub. Follow these steps to manage your projects.

1. Depending on the project's current state, different buttons will appear at the bottom of the project card.

2. Click the ‘+’ icon to add a member to the project.

3. Select the checkbox next to the member(s) you want to add, then click ‘Add Members’ to confirm.

Note: Only users you’ve invited to your account will appear in the list of available members for selection.

4. Click the user icon to view the project's member(s).

5. For help desk support, click the message icon.

6. Enter your Discord username and click the ‘Join’ button to send your request.

Note: After joining, click the icon again to access the channel related to your project.

7. Click the ‘ROI: %’ icon to open the ROI Calculator.

8. Click the calendar icon to arrange a consultation with the Xamun Team to discuss your app requirements in detail.

9. To archive a project, click on the three-dot menu in the top right corner of the project card.

10. Select ‘Archive’ to move the project to the Archived section.

11. To unarchive a project, go to ‘Archived’ section.

12. Click ‘Unarchived Solution’ to restore the project.

13. To start a new project, click the ‘+ Create Project’ button.

Reference Material

Feature	Description
+ icon	• Will display the list of available user(s) for selection.
Checkbox	• If clicked, the user will be selected.
Add Members	• Will add member(s) to the project.
Join	• Will direct to the Xamun’s Helpdesk Discord.
Save Result	• Will display the calculated ROI percentage on the project card.
+ Create Project	• Will direct to Xami.

Updated on: 09/27/2024

Adding Project Versions

Adding project versions allows you to request and manage edits to a project's prior version in the build state, ensuring any requested changes are reviewed and approved before implementation in the Design Studio. Follow these steps to add project versions.

1. From the Project Hub, select the project you wish to request a new version.

2. Click on ‘Devs Tool.’

3. Choose ‘Versioning.’

4. Provide a reason for the version request.

5. Click ‘Request New Version.’

6. To check the status of your request, click ‘Devs Tool.’

7. Select ‘Versioning’ again.

8. If needed, you can cancel the request to modify the reason.

9. To verify if the version has been approved, click the ‘Devs Tool.’

10. Select ‘Versioning’ once more.

11. Once approved, click ‘Edit New Version’ to make changes to the project.

Reference Material

Feature	Description
Reason	• Input here the reason for your project’s version request. • Required Field
Request New Version	• Will send the project’s version request to the Xamun Team.
Cancel Request	• Will cancel the submitted version request for the project.
Edit New Version	• If clicked, you can now edit your project in the Design Studio.

Updated on: 10/29/2024

Project Management Board

The Project Management Board serves as a system to manage project during the build state. It includes a dashboard for tracking project progress, user testing, payment processing, and server settings. It also features a Kanban board for task management, GitHub integration, discussion board, and a media library for resources. Follow these steps to navigate it.

1. Choose the project you wish to manage.

2. Click the ‘PM Board’ button to access the project management features.

Note: Only projects in the build state will have a ‘PM Board’ button on their project card.

3. You may now manage tasks, monitor progress, collaborate with team members, and access necessary resources.

Updated on: 10/29/2024

Solution Setup

Navigating Solution Setup

1. There are two ways to access the Solution Setup of a project, depending on the status.

a. If the solution is still on a draft status and also not yet paid, then you may access the Solution Setup by clicking the Check-out for Design Payment button which will open the Design Payment panel. In here you can either pay via PayPal by clicking the PayPal button or test out the Solution Setup without paying by clicking the Let me try it more Button, both options lead to the Solution Setup of the selected solution.

b. If the solution is already paid and still on the draft status, they may access the Solution Setup of a particular solution by clicking the Continue Working button.

c. If the Solution is already paid and still on the prepared status, they may access the Solution Setup by clicking the Review button.

2. Once you are at the Solution Setup, there are two ways to navigate to each section of the Setup. Either by scrolling using the Scroll Bar, or by going directly to the different sections via the buttons at the right side of your screen.

3. Let us go through each section one by one, the first one being the Details section. The Details section is the first component of the Solution Setup process. This section captures fundamental information about your project and its requirements.

Reference Material

Feature	Description
Project Name	• Defines the primary identifier for your project.
Application Short Description	• Provides a concise overview of the project's main functionality
Platform Selection	• Allows for multi-selection of platforms the project will be deployed on.

4. The next section is the Design Theme. The Design Theme section allows users to customize the visual appearance of their application, including logo upload, layout selection, and color scheme definition.

Reference Material

Feature	Description
Upload Web Logo	Allows for uploading Web Logo for the project. Supported File Formats: SVG, PNG, GIF
Web Layout	Provides a single selection of different layout configurations for the system. Horizontal: Features top navigation bar, Full-width content area and Standard header-content structure. Side Navigation: Vertical navigation menu, Content area with left-side navigation and Optimal for deep navigation structures. Modern: Contemporary design approach, Clean, minimalist interface and optimized for modern web standards.
Color Palette	Provides a Color Picker and Eyedropper tool for each category. Primary: Used for primary actions and key UI elements Secondary: Used for secondary elements and backgrounds. Success: Positive actions, confirmations, success messages and indicators. Info: Informational elements as well as help and additional details. Danger: Error states and critical actions. Warning: Cautionary messages as well as alert notifications.

5. The next section is the App Config, The App Config section allows users to define the technical architecture of their application by selecting the technology stack and specifying performance requirements.

6. The last section is called Requirements. The Requirements section of the Solution Setup is divided into three main categories: Performance, Security, and Compliance. Each category contains specific requirements that ensure the system is robust, secure, and compliant with industry standards.

7. While modifying and making changes throughout the Solution Setup a Realtime Project Breakdown is displayed at the side. The Project Breakdown panel provides essential financial and timeline information for the current Solution.

8. After you are done with making changes on the Solution Setup phase, you can then click the Proceed button to save the changes and navigates you automatically to the next phase.

Updated on: 10/29/2024

Build Application

Customize Module

Before starting to build your application, it's important to navigate through the Project Hub to access the necessary tools and resources. This guide will help you find your project, choose the right platform, and start the design process. Follow these steps to set up your application and customize its features.

1. From the Project Hub, click the dropdown button on the top right corner to view the list of Xamun modules.
2. Click ‘Solution Library’ to be directed to the page.

3. Click the ‘View Detail’ button on your chosen project to view its design preview.

Note: To view your projects by category, click the dropdown button next to the search bar.

4. Click on your preferred platform.
5. To start building your application, click the '‘Start Design Process’ button.

6. The 'Build Application' form will appear on your screen.
7. Enter your solution project name and write a short description of your project.
8. Select your platform by clicking the checkbox.
9. Click the ‘Proceed’ button.

Reference Material

Feature	Description
Solution Project Name	• Input here the name of your project. • Required Field
Short Description	• Input here a short description of your project.
Choose Platforms	• Choose the best platform/s appropriate for your project.
Proceed	• If clicked, you can now customized your application's module/s.

Updated on: 08/21/2024

Module Configuration

Navigate Customize Module Selection

This is the second step in creating a project. It contains the List of Modules, Page Preview, Module Description, and Solution Information.

In this step, the user can modify or add modules based on the selected Solution to fit the business needs or requirements.

By starting to enter Project Name, Select its Platform, and Short Description for your Project.

Step-by-Step Guide to Navigating the Xamun Module Page

1. Select and Configure Modules: Review the Selected Modules/Pages section on the left side. Here, you can:

○ Expand or Collapse Modules by clicking the arrow beside each module name.

○ Preview Pages by clicking on the page name, which will be displayed on the right.

○ Toggle Pages On/Off by using the switch next to the page name.

○ Access Module Settings via the gear icon to add new pages from the library or create a blank page.

2. Add New Modules:

○ Click the Add (+) Button to open a popup that allows you to add a new module from the library or a blank module.

3. Search for Additional Modules:

○ Use the Search Bar in the "Available Modules/Pages" section to find specific modules or pages.

4. Toggle Between Views:

○ Use the Web/Mobile Toggle to switch between viewing the design on a web app or mobile app platform.

5. Navigate Through Pages:

○ If a module contains multiple pages, use the Arrow Navigator to move between pages.

6. Add/Edit Notes:

○ Click Write Note or Edit Note to open the Note popup for adding or editing notes associated with your module configuration.

7. Utilize the "Working with Figma" Feature: In the upper section of the page, click the "Working with Figma" button. This feature allows you to:

○ Export Solution: Export the current design to Figma for further customization and collaboration.

○ Import Solution: Import a Figma design back into Xamun to continue development.

○ Access the Media Library: Use this to manage assets such as images, icons, and other media used in your project.

8. Define Business Rules:

○ Click on the "Business Rules" tab in the top navigation bar.

○ Here, you can manage and create User Stories by defining user roles and their interactions within the application.

9. Finalize Your Configuration:

○ After making all necessary changes, proceed to the next step by selecting “Finalize Solution” tab in the top navigation bar

○ Here, you can see the solution summary showcasing the modules included, ability to choose optional add ons, and the total cost and its breakdowns.

Reference Material

Feature	Description
Solution Project Name	• Input here the name of your project. • Required Field
Short Description	• Input here a short description of your project.
Choose Platforms	• Choose the best platform/s appropriate for your project.
Proceed	• If clicked, you can now customized your application's module/s.
Arrow Up/Down Icon beside the module	• If arrow up is clicked, it will list down all the pages of the selected module. • If arrow down is clicked, it will hide all the pages of the selected module.
Module Setting (Gear Icon)	• If clicked, it will show the two kinds of adding the page, namely: Add page from library, Add blank page.
Clickable Page Name	• If clicked, it will display the page preview.
Switch / Toggle Button	• Found on the left side of the page name. • If clicked, it will Toggle button to remove or add page.
Right Arrow beside the page name	• If clicked, it will show DESIGN PREVIEW page.
Available Modules/Pages	• If clicked, it will display more modules and pages.
Web/Mobile Toggle	• To switch between viewing the design on a web app or mobile app platform.
Arrow Navigator (left and right)	• It will be shown if the selected module has multiple pages. • If left arrow is clicked, it will navigate to the next page. • If right arrow is clicked, it will navigate to the previous page.
Write Note (Pencil icon)	• If clicked, it will open the Note popup page.
Add Page from library	• If clicked, it will redirect to ADD PAGE. • See PERSONALIZE MODULE section > ADD PAGE VIEW for more details. • Inside Gear Icon (Module Settings).
Add blank page	• If clicked, the screen will show a blank page. • Inside Gear Icon (Module Settings).
Business Rules	• You can manage and create User Stories by defining user roles and their interactions within the application.
Finalize Solution	• Allows you to review and confirm all add on configurations.

Updated on: 09/10/2024

Module List

Navigating Module List

To navigate the module list after generating your idea with Xami, follow these steps:

1. In the project hub, locate and select the project you'd like to work on. This is shown in the picture labeled as A.

2. Once you've selected the project, click on "Check-out for Design Payment".

a. Title of the project

b. Check-out for design payment

3. Click on "Let me try more!" to proceed without making a payment.

4. You will then be directed to the Xamun Design Studio for that project, where you can begin exploring and working on your project.

5. In the Design Studio, you'll see 5 sections:

a. Solution Setup

b. Module List

c. Page Details

d. Business Processes

e. Commercial Terms

Click on the Module List, which is labeled as B in the picture.

6. Once you click on the Module List, you will be directed to the Module List, where you can view and manage all available modules for your project.

Reference Material

Feature	Description
Check Out Payment	Shows the cost for the application. You can also click on "Let Me Try More" to review or edit the solution setup, module list, page details, business process, and commercial terms.
Apply Voucher	Allows you to apply a voucher to receive a discount on your design payment.
Module List	Add More Modules: Create additional modules to expand the functionality of your project. Edit Existing Modules: Modify the details of current modules as needed. Inside Each Module: Add Pages: Create and organize pages within each module to enhance content structure.

Updated on: 10/29/2024

Add Module

Adding a Module

Now that you're in the Xamun Design Studio and have navigated to the Module List, follow these steps to add a module:

1. On the screen, you'll see two options labeled A and B. Click on the module where you'd like to add a new module:

A. Web App

B. Mobile App

2. After that, click on Add Module, and a new module will be added to your project.

3. The new module should appear on the list. You can also click on the module title to rename it.

Reference Material

Feature	Description
Module	A self-contained unit within an application that focuses on a specific feature or functionality. Example: Payment Module: Handles payment processing and transactions.

Updated on: 10/29/2024

Delete Module

Deleting a module

If you need to remove a module from your project, follow these simple steps to ensure its properly deleted from the Module List in the Xamun Design Studio. Be cautious, as deleting a module is permanent and cannot be undone without recreating the module.

Steps to Delete a Module

1. Navigate to the Module List: In the Xamun Design Studio, go to the Module List section.

2. Locate the Module: Find the module you wish to delete from the list of available modules.

3. Click the Delete Icon (X): Click on the X icon next to the module you want to delete.

4. Confirm or Cancel Deletion: A pop-up will appear asking for confirmation.

a.Click Yes to delete the module.

b.Click No if you do not want to delete the module.

Notes: Be cautious, as deleting a module is permanent and cannot be undone without recreating the module.

Updated on: 10/30/2024

Add Blank Page

Adding a Blank Page

To expand your project, you can easily add a blank page to any existing module in the Module List. Follow these steps to create a blank page, which you can then customize with a title, description, and it will automatically update the pricing information.

1. Navigate to the Module List: Ensure you're on the Module List page.

2. Select the module where you'd like to add a blank page, then click on Add Blank Page.

3. Access the Dropdown: After clicking Add Blank Page, click on the dropdown next to it to see the new page.

4. You will now see the newly added blank page in the module.

A. Rename the Title: Click on the blank page to change its title.

B. Add Description: Update the description of the blank page.

5. You've successfully created and customized the blank page.

Notes: The price will automatically update once you input the title and the description.

Updated on: 10/31/2024

Page Details

Add a User Story

Add User Story enables you to create and document user stories, providing a clear description of features or functionalities from the end user's perspective. This helps teams understand user needs and plan development tasks accordingly. This guide will walk you through the steps to add a user story.

1. In the Xamun Project Hub, click on one of the projects you want to add a user story.

2. To ask Xami to generate a user story, click on the Business Rules, then Generate Now.

3. Click on the Suggest User Stories button so Xami will produce User Roles and User Stories.

4. These are the user stories generated by Xami. You can see if they are functional or non-functional, the associated roles, and use the filter button to narrow down your options.

Note: By clicking on a user story, you can view additional details such as logic & calculation and integration. You can make edits and then click Save.

5. To add more user roles, click the + button at the upper left corner, then Add User Role.

6. Complete all necessary information by filling in the following fields, then click on Save.

a. User Role
b. Description
c. Figma Flow Link

Reference Material

Feature	Description
User Role	• Specify the role of the user within the project or application (e.g., Administrator, Developer, Designer). • Required Field
Description	• Provide a detailed description of the user role, including responsibilities, permissions, and any relevant information about their function. • Required Field
Figma Flow Link	• Include a link to a Figma flow or design that visually represents the user's journey or the design process related to this role.
Save	• Click this button to save the entered details and link.

Updated on: 09/05/2024

Add Page Mapping

Page Mapping is a feature that lets you customize where an element takes users when they are triggered. Instead of having fixed element destinations, you can define and modify which page an element will lead to.

1. In the left panel, select the desired module under the "Modules" section (e.g., "Purchase Order Creation").

2. Click on the arrow icon next to the page you want to work with (e.g., "Create Purchase Order").

3. Once you are on the desired page, locate the icons on the right-hand side. Click on the Action Mapping icon. This will open the action mapping panel, where you can see the elements available for mapping.

4. To check which page an element is currently mapped to, go to the Elements section and click the chain icon next to the element (e.g., "Submit Purchase Order"). This will display the page the element is mapped to (e.g., "View Purchase Order").

Note: The page mappings are set automatically by default but can be customized according to the user’s needs.

5. To change the mapping of an element, use the dropdown menu to select the page you want to map the action to (e.g., "Purchase Order Dashboard").

Note: If the dropdown list is too long, you can use the search bar to search for the pages you want the element to be mapped to.

6. The action mapping will now be updated, setting the selected element to navigate to the chosen page when triggered.

7. Once the action mapping has been configured as desired, click the Save button in the upper right corner of the action mapping panel.

8. A confirmation dialog will appear. To cancel or continue making changes, click the No button. Otherwise, click Yes to save all the mapped configurations for the modified elements.

If the save was successful, a message will appear at the bottom of your screen confirming that your element has successfully mapped to your desired page and the new action mapping will be active for the specified elements.

Updated on: 10/29/2024

Business Processes

Add Test Cases

Add Test Case is a feature that allows users to create and document specific test scenarios for software applications. This ensures that each functionality is tested thoroughly to meet quality standards and requirements. This guide will walk you through the steps to add a test case.

1. In the Xamun Project Hub, click on one of the projects you want to add a test case.

2. Go to the Business Rules tab, then click Test Cases. To add an additional test case, click the (+) Add button.

Note: Each user story has its own test case. You can add test cases to each of the user stories.

3. Provide the information details needed, then click on Save.

a. Test Case Name
b. Steps
c. Expected Result

Reference Material

Feature	Description
Test Case Name	• Provide a name for the test case. • Required Field
Steps	• List the steps required to execute the test case. • Required Field
Expected Result	• Describe the expected outcome of the test case. • Required Field
Save	• Click this button to save the test case details.

Updated on: 09/05/2024

Uploading Pages

Uploading Pages enables you to submit an image, which the Xamun Platform will analyze to provide you with the total cost.

1. In the Xamun Project Hub, select a project you want to upload a page.

2. Click on the dropdown button beside the Module Name to reveal its pages.

3. Beside the Page Name, click on the arrow button to display the page in an expanded view on the platform.

4. To upload an image of your page, click on the ‘Upload Image’ button to open the form.

5. In the Upload Image form, click ‘Browse’ to open your file explorer and choose an image to upload.

6. After uploading an image, click the ‘Analyze’ button to assign a user story and calculate the total cost for the page.

7. After the platform completes its analysis, it will assign a user story and provide the total cost. To proceed, simply click the ‘Confirm’ button to successfully upload it to the platform.

Reference Material

Feature	Description
Upload Image button	• Displays a form for users to upload an image of a page.
Browse	• Opens the file explorer, allowing users to select and upload an image.
Analyze Button	• Assigns a user story and calculates the total cost.
Confirm Button	• Finalizes the process by uploading the image to the platform.

Updated on: 09/20/2024

Editing Pages

Editing Pages allows you to modify the content and layout of existing pages. This feature helps you update information, adjust formatting, and make other changes to ensure your pages meet current needs and standards. This guide will walk you through the steps to edit a page effectively.

1. Once you click on the project you are working on, click the dropdown button to view the page listing and choose the one you want to edit.

2. To edit, open the page by clicking the arrow next to Winning Tickets Page, then click the Edit button.

3. Provide the necessary details by filling in the fields, then click Save.

a. Page Name
b. Description
c. Note

Reference Material

Feature	Description
Page Name	• Enter the name of the page being described.
Description	• Provide a detailed description of the page, including its purpose and content.
Note	• Add any additional notes or comments related to the page that may be useful.
Save	• Click this button to save the details of the page.

Updated on: 09/05/2024

Removing Pages

Removing Pages allows you to delete unwanted or unnecessary pages from your project. This helps maintain a clean and organized structure. This guide will walk you through the steps to remove pages efficiently.

1. Once you click on the project you are working on, select one of the modules/pages.

2. Click the toggle switch button beside the page name to disable or delete the page.

Updated on: 09/05/2024

Working with Figma

Export Solution

Export Solution enables you to export your project or solution into a shareable file format, making it accessible outside the platform. This helps in distributing the project or collaborating with others. This guide will walk you through the steps to export your solution.

1. Once you select the project you are working on, click Working With Figma in the upper right corner.

2. From the dropdown list, select Export Solutions to Figma.

3. Click Download to export the solution structure and Figma files for design.

Updated on: 09/05/2024

Import Solution

To easily bring your Figma designs into your project, just follow these steps. You'll start by accessing the Figma options and finish by connecting your Figma document to your project. Here's how:

1. Click the ‘Working with Figma’ button to see the available Figma options.

2. Select ‘Import Solutions from Figma’ and the ‘Import from Figma’ form will appear on your screen.

3. Enter the access token.

4. Provide the link to the Figma document you wish to import.

5. Click the ‘Connect’ button to link the Figma document to your project.

Reference Material

Feature	Description
Working with Figma	• Shows the options on working with Figma.
Access Token	• Can be found on your Figma account, just generate and copy your personal access token.
Figma Document URL	• The url of your solution. • Copy it into your solution in Figma.
Select Canvas Page	• Choose the page of your solution in the dropdown menu.

Updated on: 09/18/2024

Page Functions

Add Functional Details

Write Note

Add a Note

To add a note to your page, follow these steps to ensure you’re in the correct section and ready to make edits. This process involves selecting the appropriate module, accessing the desired page, and entering your note into the provided form.

1. Make sure you are in the ‘UI & Page Development’ section.

2. Select your module.

3. Press the arrow button next to the page you wish to access.

4. The page will appear on your screen.

5. Select the edit button next to your page's name.

6. The 'Page Detail' form will appear on the right side of your screen.

7. Enter your note in the 'Note' section of the form.

8. Click 'save' to store your input.

Feature	Description
Edit button	• Will display the ‘Page Detail’ form on the right side of the screen.
Save	• Will save the changes made on the page detail.

Updated on: 09/06/2024

Finalize

Solution Summary

To complete your project solution with Xamun, follow this guide to review the details of your solution, including cost and platform information. 

1. Click the ‘Finalize Solution’ tab to ensure you are in the correct section. 

2. Tap the checkbox for the options you want to apply to your project. 

3. Click the toggle buttons for the cloud hosting services you wish to use. 

4. Click the dropdown button for your chosen cloud hosting; your options are Small, Medium, and Large. 

5. Select your preferred platform. 

6. Your grand total cost will update each time you change your selections. 

7. Click the ‘Request for Proposal’ button to finalize.

Note: If you want to edit another solution, click the ‘Edit Solution’ button. 

8. A message will display on your screen. 

9. Click the ‘Submit’ button.

Reference Material

Feature	Description
Checkbox	• If clicked, the service will be selected.
Toggle button	• If clicked, the cloud hosting will be selected.
Request for Proposal	• Will display the confirmation message.
Submit	• Will send the project to the Xamun Team.

Updated on: 09/06/2024