Specifications Management Overview

Specifications: Overview

Specifications in Reqode are connected artifacts that describe how different parts of the software are implemented. Each specification contains a text description and additional attributes that define behavior, structure, or constraints.

Specifications are divided into several main types. For each main type, you can define custom sub-types. Depending on the specification type, it may contain specific attributes and links to other artifacts.

Specification Types

Reqode provides the following built-in specification types:

Features

Features describe system functionality and non-functional requirements.

This is the central artifact in Reqode. Features connect other specifications, tests, source code, and tasks.

The Feature type cannot be disabled. All other specification types complement Features and are used to support their implementation. Depending on the project needs, they can be disabled.

Data Entities

Data Entities are used to describe the data model.

Each specification represents a data entity, including its attributes and relationships with other entities.

User Interfaces

User Interface specifications describe the user interface.

They allow you to define screens, forms, and dialogs as separate specifications.

You can use the prototype editor to create UI prototypes manually or generate them with AI based on the text specification.

Software Interfaces

Software Interfaces are used to describe technical interfaces.

They allow you to define specifications for API methods, socket calls, and other ways subsystems interact with each other.

Custom Artifacts

Custom Artifacts allow you to create your own specification sub-types.

They are used to structure elements that are important for a specific project, such as:

• configuration variables
• events
• notifications

Custom Artifacts can be linked to related Features.

Specification Sub-types

For each specification type, you can define sub-types.

Sub-types define:

• the specification template
• additional attributes (depending on the main type)
• instructions for AI assistants on how to generate and update specifications of this sub-type

Sub-types help establish common rules for writing specifications. These rules are followed by both the development team and AI assistants.