Feature Introduction

The Waterfall project design feature is an essential tool for efficiently managing design documents during the design phase. It systematically handles various design documents throughout the project lifecycle, including high-level designs, detailed designs, database designs, and API designs.

Users can customize design types in the Admin section to flexibly adapt to different project requirements. This feature supports actions such as creating, changing, viewing, linking commits, and deleting design documents. It also provides a convenient search function, enabling teams to quickly retrieve required documents.

By accurately managing design documents, project development team members can comprehensively and systematically perform software system design based on story documents, thereby improving transparency and collaboration efficiency in the design process.

I. Create designs

Navigate to Design > Create Design to enter the design creation page.

图1

If stories are already linked, you can select them from the "Related Stories" dropdown menu. This allows you to write a design document for a specific story within the Waterfall project.

The "Design Type" is a required field, which you can also select from a dropdown menu.

After selecting related stories, you can view the linkage between stories and designs in the project matrix, which we will introduce later.

图2

After clicking Submit, you can see the newly created high-level design in the design list. Design-type documents are presented as text documents or file attachments.

You can view them using tabs such as All, High-level Design, Detailed Design, Database Design, and API Design, or you can use search conditions to find specific items.

图3

II. Change, assign, and delete designs

After successfully creating a design, you can change and delete it using the action buttons in the design list.

Changing a design means editing or modifying it. In Waterfall projects, design changes require a formal review.

Assigning a design means designating a person to write, track, and manage the document. This concept is similar to assigning a task.

If a design is deleted, you can restore it by navigating to Admin > System Settings > Recycle Bin.

图4

III. View commits

In the action column, you can use the View Commits button to check related code commit records and link commits to the design. Clicking this button will take you to the related commits viewing page.

图5

Click the Link Commit button to associate new code commits with the design. You can select the desired commits from a specific time period within the repository linked to the project, and then click the Save button at the bottom.

图6

Once successfully linked, you can see the commits on the viewing page. A single design can be linked to multiple commits.

If a commit is linked by mistake, you can remove it using the Unlink button in the linked commits list.

Linked commits can also be viewed in the project matrix, which we will discuss next.

图7

IV. Customize design types

You can customize design types by navigating to Admin > Model Configuration and configuring the design settings under the corresponding project model.

图8