- What's New
- Function Overview
-
Service Overview
- What Is CodeArts Req?
- Advantages
- Use Cases
-
Features
- Multiple Built-in IPD Requirement Models
- E2E Traceability
- Baseline Management and Change Review
- Efficient Cross-Project Requirement Collaboration
- System Feature Management
- Customers' Raw Requirements Management
- Bug Full Lifecycle Management
- Efficient Cross-Organization Collaboration for Bug Tracking and Management
- Bug Trend Analysis and Quality Measurement
- Traceable Fixing Process
- Customizable Fixing Process
- Security
- Permission Management
- Constraints
- Getting Started
-
User Guide
- CodeArts Req Usage Process
- Purchasing and Authorizing CodeArts Req
- Accessing the CodeArts Req Homepage
- Creating a CodeArts Project
- Managing Scrum Project Requirements
-
Managing IPD-System Device Project Requirements
- Requirement Management Process
-
Configuring Common Settings
- Configuring Common Work Item Fields
- Configuring Common Work Item Statuses
- Configuring Work Item Templates
- Configuring Work Item Status Flows
- Configuring Work Item Tags
- Creating Work Item Modules
- Creating Work Types
- Configuring Work Item Status Roll-up Rules
- Configuring Notification Rules
- Viewing Work Item Import/Export Records
- Creating and Managing RRs
- Creating and Managing a Feature Tree and System Features
- Configuring Project Plans
- Creating and Managing R&D Requirements
- Creating and Managing Tasks
- Creating and Managing Bugs
- Reviewing Work Items
- Tracking the Project Progress
-
Managing IPD-Standalone Software Project Requirements
- Requirement Management Process
-
Common Configuration Management
- Configuring Common Work Item Fields
- Configuring Common Work Item Statuses
- Configuring Work Item Templates
- Configuring Work Item Status Flows
- Configuring Work Item Tags
- Creating Work Item Modules
- Creating Work Types
- Configuring Automatic Roll-up Rules
- Configuring Notifications
- Viewing Work Item Import/Export Records
- Creating and Managing RRs
- Creating and Managing a Feature Tree and System Features
- Configuring a Plan
- Creating and Managing R&D Requirements
- Creating and Managing Tasks
- Creating and Managing Bugs
- Reviewing Work Items
- Tracking the Project Progress
- (Optional) Checking Audit Logs
-
Best Practices
- CodeArts Req Best Practices
- Best Practices of Scrum Projects
- Using IPD-System Device Projects to Manage RRs of a Smart Watch R&D Project
- Using IPD-System Device Projects to Manage Defects of a Smart Watch R&D Project
- Using IPD-System Device Projects to Perform a Baseline Review (BR) on a Smart Watch R&D Project
- Using IPD-System Device Projects to Manage Feature Trees of a Smart Watch R&D Project
- Huawei E2E DevOps Practice: Managing Requirements
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
-
Work Items of the Scrum Project
- Creating a Customized Field for a Work Item Type
- Uploading an image
- Obtaining Work Item Completion Rate
- Obtaining Comments on a Specified Work Item
- Querying Labor Hours by User (Single Project)
- Querying Labor Hours by User (Multi-Project)
- Obtaining the Work Item History
- Create work items.
- Querying Work Items of a Project
- Advanced Query Work Item
- Deleting Work Items in Batches
- Querying Work Item Details
- Updating a Work Item
- Deleting a Work Item
- Obtains sub-work items.
- Querying Historical Records of All Work Items in a Project
- Querying the Work Item Transfer Configuration of a Scrum Project
- Creating a Work Item as a Fine-grained Permission User
- Queries the work items associated with the current work item.
- Queries the associated Wikis associated with the current work item.
- Queries the code submission records or branch creation records associated with the current work item.
- Querying Associated Wikis
- Querying Customized Fields of Scrum Work Items
- Downloading an Image
- Uploading an Attachment to a Work Item
- Iteration of the Scrum Project
- User Information
- Project members
- Project Information
- Project Indicators
- Project Statistics
- Modules of the Scrum Project
- Domain of the Scrum Project
- Scrum Project Statuses
-
Work Items of the Scrum Project
- Application Examples
- Appendixes
- Change History
-
FAQs
-
Work Items
- How Can I Assign One Scrum Project Work Item to Multiple Members?
- Why Is a Message Reporting Duplicate File Name Displayed During File Association in a Scrum Project?
- How Do I Handle the Verification Exceptions in the Number of Work Items Imported to an IPD Project?
- How Do I Modify the Recipient After an IPD Project Requirement Is Assigned?
- Member Management
-
Troubleshooting
- Why Is the Message "You have been invited to run projects with another account. Accept invitation" Displayed When Inviting Other Users to Join My Project in CodeArts Req?
- Why Can't I Create a Project Using "DevOps Full-Process"?
- Why Is a Message Indicating the Field Name Already Exists Displayed When Setting a Work Item Field in a Scrum Project?
-
Work Items
- Videos
- General Reference
Copied.
Managing Requirements in a Structured Manner
Why Do We Need to Manage Requirements in a Structured Manner?
We do not need structured management of software project requirements in all circumstances. If it is a transaction management requirement on the recording and status tracking during implementation, which does not need continuous tracking and requirement association maintenance afterwards, structured requirement management is not required. In this case, both the Scrum and Kanban project templates of CodeArts can be used to manage requirements and software projects. Structured requirement management is required only when there are a large number of interrelated requirements and implemented requirements need to be managed and maintained. In this case, we need to use the Scrum project template in CodeArts, whose "Epic-Feature-Story" structure and requirement planning function are helpful for structured management.
What Is Structured Requirement Management Based on?
Software R&D is either project-based or product-based. In general, the former is temporary or short-term, while the latter is long-term or requires continuous maintenance and update of functions and features. We can achieve project objectives and deliver the required functions and features by continuously improving the software product or system. This means that our structured requirement management needs to be based on product or system functions and features. Information such as versions, customers, and modules that software project management focuses on can be implemented through different attributes or even tags of requirements.
Using CodeArts for Structured Requirement Management
The recommended procedure is as follows:
- Step 1: Create a CodeArts project.
Create a CodeArts project for a product or system. All requirements of the product or system are managed in the CodeArts project.
- Step 2: Establish an "Epic-Feature-Story" requirement structure.
- Epic needs to carry business value, that is, an epic needs to be meaningful to the enterprise itself.
Service modules of a product or system, such as the user center, shopping cart, and delivery management, can be an epic. For example, it is suitable for a cloud-based freight company to take the fuel card service as an epic so that functions related to the fuel card can be used as features.
- Feature needs to bring benefits to users. That is, users can understand and recognize the value of a feature. Generally, a feature can be directly perceived and operated by users.
Features are what service modules are broken down into. Simply speaking, a feature is a service or user process. If the user center is taken as an epic, user information, order management, or address management can be a feature. If the fuel card service is taken as an epic, purchasing a fuel card or managing fuel cards can be a feature.
- A feature is usually large and complex. Therefore, it needs to be broken down to small-granularity stories to carry a specific user operation.
For example, viewing all orders, filtering orders, changing user aliases, and customize profile pictures are stories.
- Tasks, at one level lower than stories, are mainly used for work division and collaboration. That is, stories that can be assigned to specific people do not need to be broken down.
Tasks are specific work that engineers need to do, which are irrelevant to the business value, user value, and single operations of users. Generally, stories are broken down into tasks based on specific components and modules (such as front end, background, and database) or work processes (such as UCD, development, test, and deployment).
The following figure is an example:
- Epic: user center
- Feature: address management
- Story: address creation
- Task: [Web client] page entry and address editing form or [Database] user address data table design and implementation
Figure 1 Requirement planning
- Epic needs to carry business value, that is, an epic needs to be meaningful to the enterprise itself.
- Step 3: Manage different modules and versions based on work item attributes.
Figure 2 shows the attributes on the work item details page.
- Module: web client.
- Release Version: 1.0.1.2.
To maintain a module list, click
next to the Module field on the editing page of the work item. In the displayed window, you can add, modify, or delete a module.
Figure 3 Editing a moduleIn the backlog view of work item management, after adding the Module field in the Select Field window, you can easily view the modules related to the work item and filter the modules.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot