This page is under construction

Work in progress ...

Getting started


Installing from source

The following software must be installed prior to installation and running openADAMS from source:

The artifact editor saves all artifacts, folders and relations between artifacts in a database file. Images included in artifact fields are also saved in this database.

To install openADAMS from source please download the latest archive from Sourceforge. After unzipping the archive to an arbitrary folder you should be able to start openADAMS by running either the script or oaeditor.pyw.

Win32 binary installation

Download the latest archive from Sourceforge. Unzip the archive to an arbitrary folder and run oaeditor.exe to start openADAMS.

User interface basics

Move mouse to one of the bubbles bubble in the image to see the meaning of the element.

Sorry, your browser is not able to display this object!

Creating and opening a database

Use the menu item New database from the File menu or use the shortcut Ctrl-N to create a new database. A default folder layout will be created automatically.

To open an existing database choose the menu item File/Open database or use the shortcut Ctrl-O.

file menu screenshot

Creating and editing artifacts

To create a new artifact select the appropriate artifact type from the Edit menu or press the corresponding toolbar button.
edit menu screenshot
The new artifact will go to the folder selected in the tree view. If not a folder but an an artifact is selected, the newly created artifact will go to the same folder as the selected one. The new artifact will get a default title.

To edit an artifact simply double click it in the tree view. A dialog box for editing attributes and text fields of the artifact then appears.
edit dialog screenshot

The dialog for most kind of artifacts has several tabs. In the first tab all the attributes and text fields could be edited. The other tabs contains checkable lists to manage links between artifacts.
edit dialog screenshot

The multiline text fields of artifacts could be edited in another way too. Each multiline text field has a clickable label in the details panel. Clicking opens a more or less comfortable text editor for the corresponding multiline text field.
text editor screenshot

Types of Artifacts

openADAMS supports 7 basic artifact types:
Text sections
Used for plain text. A text section artifact has an ID, a title, some keywords and the actual content.
Are used to describe product functions or properties, i.e. from the customers or marketing point of view. Features are useable to derive requirements. Features have an ID, title, keywords, priority, risk, status and a description. Features could be linked to requirments and use cases.
Requirements as one of the most import type of artifacts have a lot of fields and attributes: ID, title, keywords, priority, status, risk, category, complexity, assigee, effort, baseline, description, testability, origin and rationale. Requirements could be linked to use cases, test cases and components.
Use cases
Are used to document a use case. Attributes and fields of a use case artifact are ID, title, keywords, priority, use frequency, actors, stakeholders, prerequisites, main scenario, alternative scenario and notes. Use cases could be linked to requirements.
Basic architectural documentation is supported through component artifacts. Attributes and fields of a component are ID, title, keywords, kind of component and description. Components could be linked to requirements.
Test cases
A test case describes a test for one or more requirement. Fields and attributes of a test case are ID, title, keywords, priority, purpose, prerequisite, test data, steps, notes and a script URL. Test cases are linked to requirements and test suites.
Test suites
A test suite is simpy a container to organize test cases. A test suite artifact has an ID, a title, some keywords and a description.

Another kind of artifacts are images. In any multiline text field of an artifact images may be inserted. But only those images which are stored in the database file could be inserted. Use Edit/Add image from the menu strip to add an image to the database.

Linking Artifacts



Exporting database