Core Concepts
Understand projects, branches, subsystems, requirements, and the artifacts they connect.
Project and branch
A project holds the model for a product. Start by checking the project and branch in the header. A new project opens on Main Branch. A separate project branch gives the team a place to prepare changes to the model before merging them into Main.
Subsystem and module
A subsystem identifies an implementation boundary such as a backend, web application, or integration service. Its architecture guidance and Unit Types describe how things are built in that part of the product.
A module groups requirements for related product behavior. A requirement belongs to a module and can be associated with the subsystems involved in implementing it.
Requirement and specifications
A requirement describes expected behavior and how to tell whether that behavior is correct. Use its key to find or share it. Open the requirement's Specifications block to see connected artifacts.
| Artifact | What it describes |
|---|---|
| Data Entity | A business object or a set of values, with attributes and relationships where applicable. |
| User Interface | A screen or component, including its behavior and any associated wireframe. |
| API Operation | A contract for an interaction exposed by an API. |
An artifact's revision identifies a particular version of its specification. The detail view can show the current revision or an earlier one. Use the branch and revision together when comparing decisions or sharing context with someone.
Software Unit and test evidence
A Software Unit identifies a piece of implementation with a clear responsibility. It can connect source files and dependencies to the specifications it implements. Its Unit Type describes the expectations for that kind of code, such as an action, controller, or component.
A Test Case describes a check for the required behavior. Its results record what happened during a particular test execution.