Skip to main content

Code Module

The Code module is designed to assist software development professionals by leveraging generative AI to streamline code snippet generation, subtask creation, and documentation. This enhances efficiency, allowing developers to focus on core tasks.

Getting Started: Setup Configuration​

Before using the Code module's features, you must first create a Setup. The Setup defines the context for your project, including the project, development stack, and profiles.

Creating a New Setup​

  1. Navigate to Setup: Go to the "Setup" page to see a list of existing configurations or create a new one.

    Setup Listing – Setup Management Screen

  2. Initiate Creation: Click the "Create Setup" button to begin.

  3. Select a Project: Choose a project from your organization's board. This is a mandatory step.

    Select a Project Field on the Create Setup Screen

  4. Define the Development Platform: Select "configure manually" for now. Future updates will include predefined platform configurations. This will reveal the "Stack" and "Profile" fields.

    Stack and Profile Fields on the Create Setup Screen

  5. Create and Assign Stacks:

    • Click the magnifying glass and then "Create New Stack."
    • Enter a name for your stack (e.g., "React," "Node.js") and press "Enter."
    • You can add multiple stacks and edit or remove them as needed.
    List of Stacks on the Create Setup Screen

  6. Create and Assign Profiles:

    • Similar to stacks, click "Create New Profile."
    • Name your profile (e.g., "Frontend Developer," "Backend API") and press "Enter."
    Select a Profile Field – Create Setup Screen

  7. Save the Setup:

    • Click "Save" to finalize the configuration. You will be redirected to the homepage with a success notification.
    • Alternatively, click "Cancel" to discard the setup.
    Saved Setup – Setup Management Screen

Managing Existing Setups​

From the "Operations" column on the Setup listing page, you can:

  • View: See the details of a saved setup.
  • Edit: Modify an existing setup.
  • Delete: Remove a setup after confirming in a pop-up modal.
Delete Modal – Setup Management Screen

AI-Powered Features​

Once your setup is configured, you can use the following AI-driven tools.

Subtask Generation​

This feature uses AI to create structured subtasks from user stories, streamlining your development workflow.

How to Generate Subtasks​

  1. Select a Setup: Choose the relevant setup for your task.

  2. Provide a User Story:

    • Manual Input: Describe the user story with enough detail for the AI to understand the context and acceptance criteria.
    • Integrated Platform: If your organization is linked to a management platform, you can select a user story directly from a dropdown list.
    Integration with Management Platforms

    When a management platform is linked, the "Describe Your User Story" field becomes a dropdown menu populated with stories from the selected project, ensuring contextually relevant selections.

    User Story Field with Provider – Create Subtask Screen

  3. Select a Profile: Choose the profile that best fits the subtask.

  4. Define Number of Results: Specify how many subtask variations the AI should generate.

  5. Generate: Click "Generate" to create the subtasks.

Interacting with Generated Subtasks​

The AI will produce titles and descriptions for the subtasks. You can:

  • Edit Formatting: Adjust the text formatting.
  • Copy: Copy the description to your clipboard.
  • Delete: Remove any unwanted results.
  • Create on Board: If integrated with a management platform, a button will appear to create the subtask directly on your board.
  • Chatbot: Use the integrated chatbot to refine the results or ask for new suggestions.
Chatbot – Create Subtask Screen

Code Generation​

Generate code snippets based on your user stories and subtasks.

How to Generate Code​

  1. Select Setup and Stack: Choose the appropriate setup and the stack(s) to be used for code generation.

  2. Provide User Story and Subtask:

    • Manual Input: Describe the user story and subtask.
    • Integrated Platform: Select the user story and subtask from dropdown menus if a management platform is linked.
    Help Icons

    Click the help icons for guidance on how to best describe your user stories and subtasks for optimal results.

  3. Specify Number of Outputs: Decide how many code variations you want.

  4. Generate: Click "Generate" to start the process.

Working with Generated Code​

The AI will generate code in cards based on the selected stacks. You can:

  • Copy Code: Copy the snippet to your clipboard.
  • Delete Code: Remove any unwanted code generations.
  • Comment on Subtask: If integrated with a management platform, you can post the code as a comment on the corresponding subtask.
  • Chatbot: Interact with the chatbot for further clarification or modifications.
Generated Results by AI – Code Generation Screen

Code Documentation​

Automatically generate documentation for your code.

How to Document Code​

  1. Paste Your Code: Insert your code snippet into the provided field.
  2. Choose a Documentation Format:
    • In-code comments: Adds comments directly to your code to explain its functionality.
    • Text (markdown): Generates a separate markdown document with an overview and explanation of the code.
Result of the documentation generation in the provided code