Modules and document view

A module is a document in the project, for example a requirements specification, a system specification or a test specification. It consists of artifacts structured into chapters by headings. A project can have any number of modules; you create them in the project overview.

Structure of a row

Each row shows the number in the module on the left and the artifact next to it:

• ID (e.g. #33): the fixed number of the artifact in the project. It stays the same even if the artifact is moved or is in several modules. A click opens the artifact page.
• Type with icon and colour,
• attribute values as badges (coloured for enumerations with a colour),
• links with count; a warning icon shows suspect links (Traceability),
• comments with count,
• a light bulb icon if the wording check has hints,
• below, the title and text. Glossary terms in the text are underlined with dots.

Numbering

Numbers are calculated from the outline and never maintained by hand:

Number	Meaning
1, 2, 1.2	headings (chapters and sub-chapters)
1.2-3	third artifact in chapter 1.2
0-1	artifact before the first heading

If you move a chapter, the numbers change automatically. The ID (#33), on the other hand, always stays the same and is therefore suitable for references in e-mails, tickets and test reports.

Creating and editing content

• Heading and Artifact at the top right create a new element at the end of the module.
• The ⋮ menu on each row offers: open details, edit, new artifact after this or in the chapter, indent and outdent, insert into another module, remove from module and move to trash.
• Edit opens the row as a form with type, title, text and all attributes of the type. Required fields are marked with *.

The text is restricted rich text: bold, italic, underline, strikethrough, superscript and subscript, lists, quotes, links and simple tables. Template … inserts sentence patterns based on EARS. Hints on vague or incomplete wording appear below the editor while you type. You attach images on the artifact page.

Changing the outline

• Drag and drop: grab a row by the handle on the left and drag it to the new position. A heading takes its sub-chapters and content with it.
• Indent and outdent move an element one level down or up.
• Only headings can have children. An artifact below a requirement is not intended; use links for that (e.g. refines).

Remove from module or delete?

Action	Effect
Remove from module	The artifact disappears only from this module. It remains in the project, in other modules and with all links.
Move to trash	The artifact disappears from all modules. It can be restored from the trash including its position.

Reuse in several modules

Also insert into another module puts the same artifact into a second module, for example a constraint that applies to several specifications. It is not copied: every change applies everywhere, and the artifact page shows all places where it is used.

Working at the same time

If two people edit the same artifact, the last save does not simply win. Whoever saves later receives a notice with the state saved in the meantime and can load it and enter their change again.

Further functions

• Comparison with a baseline: the selection at the top left marks artifacts that are new or changed since a baseline.
• Compact hides texts, long attributes and images and shows titles and badges closer together. The setting is remembered in the browser.
• Table opens the module in the table view.
• Word creates the module as a Word document with chapters, numbers, text and attributes.
• The gear opens name, description and deletion of the module. When a module is deleted, its artifacts remain in the project.
• Large modules load further sections while you scroll.