Integrating Jira

Generating Requirement and Design Documents

1. Log in to CodeArts Agent by referring to Quick Start.
2. On the top menu bar of the IDE, click File and choose Open Project to open the cloned code repository url-link-extractor.
3. On the CodeArts Agent page, select the Spec-Driven mode.
4. In the input box on the chat panel, enter the following prompt and click :

   Requirement scenario: I need to obtain all links starting with a specified URL and the titles of the corresponding web pages. For example, if the URL starts with https://support.huaweicloud.com/intl/en-us/usermanual-cli/, the complete URL I need is https://support.huaweicloud.com/intl/en-us/example.html, and the web page title is the <title> text of the page. One example link is https://support.huaweicloud.com/intl/en-us/usermanual-cli/codeartsagent_cli_0001.html, and the web page title of this link is "What Is CodeArts Agent CLI?" Based on this requirement, output the requirement design document.

5. After the requirement specification design task is complete, click Accept All to incorporate the generated content is into the requirement document spec.md.

   According to AI's reply, you can go to the generation path to review the spec.md file. Check whether the generated content meets your requirements. If you want AI to optimize the requirement document, continue to interact with it on the chat panel.

6. (Optional) For example, if you want AI to continue to optimize the spec.md file, enter the following prompt in the text box on the chat panel and click :

   Please optimize the extracted links. Do not display them in the .../codeartsagent_cli_0001.html form. Instead, display complete URLs, for example, https://support.huaweicloud.com/intl/en-us/usermanual-cli/codeartsagent_cli_0001.html.

   After optimization, you can view the spec.md file again.

   • You can also manually modify the spec.md file. After the modification, click Accept All on the chat panel.
   • If you want to use AI to continue the optimization, click Accept All and continue the interaction with AI.

7. Based on the created requirement document, click Start Create Solution on the chat panel. AI will generate a design document based on the requirement document.
8. After the architecture document creation task is complete, click Accept All to incorporate the generated content into the design document design.md.

   According to AI's reply, you can go to the generation path to view the design.md file. Check whether the generated content meets your requirements. If you want AI to optimize the design document, continue to interact with it on the chat panel.

9. (Optional) For example, if you want AI to continue to optimize the design.md file, enter the following prompt in the text box on the chat panel and click :

   Please optimize the output: The file name should be result.xlsx, and the table should contain the complete URLs and page titles after crawling.

   1. After optimization, you can view the spec.md file again.
      1. You can also manually modify the spec.md file. After the modification, click Accept All on the chat panel.
      2. If you want to use AI to continue the optimization, click Accept All and continue the interaction with AI.
   2. After the spec.md file is saved, click Start Create Solution to regenerate the corresponding design.md file.

Uploading the spec.md and design.md Files

After the spec.md and design.md files are generated, perform the operations in this section to upload the spec.md file to Jira and assign the owner, and upload the design.md file to Confluence.

1. In the input box on the chat panel, enter the following prompt and click :

   Archiving spec.md to Jira.

2. Select the project to be archived as prompted by AI and click Submit. In this practice, the devops project is selected.

   After the requirement document is successfully submitted to Jira, AI will return the following information:

   The spec.md file has been successfully archived to Jira.
   Field	Value
   Issue Key	KAN-1
   Project	devops (KAN)
   Type	Task
   Title	URL link title extraction component - Requirement specifications (spec.md)
   Link https://ltest.atlassian.net/browse/KAN-1

3. Open the Jira unified account login page.
4. In the navigation pane on the left, click Jira. Then, click the created project space devops to enter the devops space.
5. Click in the row of the to-do item in the preceding requirement document to assign the current logged-in account to an owner.
6. In the navigation pane on the left, click Confluence to go to the Confluence homepage.
7. In the navigation pane on the left, click Spaces.
8. In the displayed dialog box, click Create a space, enter a name under Name this space (devops-confluence is used in this practice), select the Knowledge base card, and click Next. On the displayed Confirm your knowledge base page, retain the default settings and click Create space.

   After the space is created, the system automatically redirects you to the home page of devops-confluence.

9. In the input box on the CodeArts Agent chat panel, enter the following prompt and click :

   Synchronize the design.md file to Confluence.

10. Select the space to be archived as prompted by AI and click Submit. In this practice, devops-space is selected.

    After the design document is successfully synchronized to Confluence, AI will return the following information:

    The design.md file has been successfully archived to the Confluence devops-confluence space.
    Field	Value
    Page ID	393218
    Space	devops-confluence (devopsconf)
    Title	URL Link Title Extraction Component - Implementation Solution (design.md)
    Link	https://jira-test.atlassian.net/wiki/spaces/devopsconf/pages/393218
    The page content includes the entire design.md document (including PlantUML code blocks such as the architecture diagram, state machine, interface list, and class diagram), with the associated Jira issue KAN-1 and document source file path marked at the end.

11. In the input box on the chat panel, enter the following prompt and click :

    Obtain the Jira requirements assigned to me for development.

    The to-do item is successfully assigned, and AI returns the following information:

    Total to-be-developed Jira requirements assigned to you: 1
    Link: https://test.atlassian.net/browse/KAN-1
    Reported by/Handled by: example
    Description: entire spec.md document (including six chapters, result.xlsx export constraints, and absolutely complete URL rules)
    This is the only uncompleted requirement assigned to you. Do you want to change its status, add a comment, or perform other operations?

Generating tasks.md

After obtaining the assigned to-do items, you can follow the instructions in this section to generate the tasks.md file.

1. In the input box on the chat panel, enter the following prompt and click :

   Read the corresponding design.md file on Confluence and sort out and extract key development points.

2. AI will extract key development points and proceed to the next phase to generate the tasks.md file.
3. After the tasks.md file is generated, click Accept All to incorporate generated content into the coding task planning document tasks.md.

   According to AI's reply, you can go to the generation path to review the tasks.md file. Check whether the generated content meets your requirements. If you want AI to optimize the requirement document, continue to interact with it on the chat panel.