Feature Overview

The Design feature in Waterfall projects is an efficient tool for managing design documents during the design phase. It enables teams to systematically handle different types of project design documentation across the project lifecycle, including high-level design, detailed design, database design, and interface design.

Users can also customize design types in the admin settings to fit different project needs. The feature supports creating, changing, viewing, submitting, and deleting design documents, and also provides convenient search capabilities so team members can quickly find the documents they need.

With precise design document management, project team members can carry out software design in a complete and structured way based on requirement documents, improving both process transparency and collaboration efficiency.

I. Create a Design

Click Design > Create Design to open the design creation page.

图1

If requirements have already been linked, you can select a Related Requirement from the drop-down list. This allows you to create a design document for a specific requirement in the Waterfall project.

Design Type is a required field and can also be selected from the drop-down list.

After a related requirement is selected, the relationship between the requirement and the design can later be viewed in the project matrix, which is introduced in the next section.

In Sanplex Standard, after a related document is selected, it can also be viewed on the design details page and in object associations.

图2

After clicking Submit, the newly created high-level design document will appear in the design list.

Documents under different design types can be presented either as documents or as attachments.

You can view them using tabs such as All, High-Level Design, Detailed Design, Database Design, and Interface Design, or locate them through search filters.

图3

II. Change, Assign, or Delete a Design

After a design is created successfully, you can use the action buttons in the design list to change or delete it.

A change means editing or revising the design. In a Waterfall project, design changes need to go through review.

Assign To can be understood as assigning someone to draft, track, and manage the document. This works in a similar way to task assignment.

After a design is deleted, it can still be restored from Admin > System Settings > Recycle Bin.

图4

III. View Commits

In the action area, click View Commits to see related code commit records and the commits linked to the design.

Click View Linked Commits to open the page for viewing commits related to the design.

图5

Click Link Commits to associate commits with the design.

You can select commits from the repositories linked to the project within a specified time range, then click Save at the bottom of the page to complete the association.

图6

After the association is completed, the linked commits can be viewed on the details page.

A design can be linked to multiple commits.

If a commit was linked by mistake, you can remove the association using the Unlink button in the linked commit list.

The linked commits can also be viewed later in the project matrix introduced in the next section.

图7

IV. Customize Design Types

Go to Admin > Model Configuration, find the Design configuration item under the corresponding model, and customize design types as needed.

图8