Documentation formats
| Requirement kind | Documentation formats |
|---|---|
| Primary (user) requirements |
Free text — the requirement is stated in the user's language (Issues, Requests, change requests). User Story — the text is written in a specific way that reflects the goal and the business context of the required functionality. |
| Business requirements |
Files obtained from external sources (regulations, laws, correspondence, and so on) Hierarchically structured requirements (documents) with a verbal description of business processes, business rules, and business constraints. Requirements recorded in the form of business models, for example using BPMN notation. |
| System requirements |
Technical specification — a document that contains requirements of different types and text of a general nature. Specification — a document that contains requirements of one type concerning one subsystem. Use Cases — the requirement is written in a specific way that describes interactions with the system. UML models — requirements for the informational, structural, and behavioral aspects of the system, written in a widely known modeling language. UI mockups — requirements for the user interface. |
The WYSIWYG editor lets you document:
- Mathematical formulas
- UML models, using the PlantUML language or the draw.io model-building tool
- BPMN models, IE models, and other kinds of diagrams, using the draw.io model-building tool
Compact requirements
Sometimes a requirement takes a compact form, so that the whole requirement fits in "Text" and the "Caption" field is redundant. In the settings of the requirement create/edit form, you can clear the required flag for the "Caption" field, remove the default value, and, in general, move "Caption" to the "Additional" tab.
