Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/spec/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,3 @@ has_children: true
# OpenFastTrace Specification

This section contains the formal specifications for OpenFastTrace.

* [System Requirements](system_requirements.md)
* [Design](design.md)
1 change: 1 addition & 0 deletions doc/user_guide/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Installation
parent: User Guide
has_children: true
nav_order: 2
---

## Installation
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/installation/linux.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Linux Installation
parent: Installation
grand_parent: User Guide
nav_order: 1
---

## Linux Installation

There are several ways to install OpenFastTrace on Linux, depending on your distribution and preference.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/installation/macos.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: macOS Installation
parent: Installation
grand_parent: User Guide
nav_order: 2
---

## macOS Installation

OpenFastTrace can be installed on macOS using Homebrew or manually via a JAR file.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/installation/windows.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Windows Installation
parent: Installation
grand_parent: User Guide
nav_order: 3
---

## Windows Installation

On Windows, OpenFastTrace is typically run manually via the JAR file.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/introduction/concepts_and_terms.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Concepts and Terms
parent: Introduction
grand_parent: User Guide
nav_order: 4
---

### Concepts and Terms

OpenFastTrace uses unified terminology for all documents. Please refer to the [central terminology document](../../terminology.md) for core definitions of terms like [specification item](../../terminology.md#specification-item), [coverage](../../terminology.md#coverage), and [artifact](../../terminology.md#artifact).
Expand Down
1 change: 1 addition & 0 deletions doc/user_guide/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Introduction
parent: User Guide
has_children: true
nav_order: 1
---

## Introduction
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/introduction/what_is_requirement_tracing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: What is Requirement Tracing?
parent: Introduction
grand_parent: User Guide
nav_order: 2
---

### What is Requirement Tracing?

OpenFastTrace is a requirement tracing suite. Requirement tracing helps you to keep track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/introduction/who_should_read_this_document.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Who Should Read This Document?
parent: Introduction
grand_parent: User Guide
nav_order: 1
---

### Who Should Read This Document?

This document is mainly targeted at users wanting to learn how to use OFT for authoring requirement specifications, tracing requirement coverage and converting between requirement formats.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Why do I Need Requirement Tracing?
parent: Introduction
grand_parent: User Guide
nav_order: 3
---

### Why do I Need Requirement Tracing?

Requirement tracing is a safety net for non-trivial software projects:
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/oft_api/exit_codes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Exit Codes
parent: OFT API
grand_parent: User Guide
nav_order: 2
---

### Exit Codes

The OFT command line interface returns the following exit codes:
Expand Down
1 change: 1 addition & 0 deletions doc/user_guide/oft_api/oft_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: OFT API
parent: User Guide
has_children: true
nav_order: 5
---

## OFT API
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/oft_api/using_oft_from_java.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Using OFT From Java
parent: OFT API
grand_parent: User Guide
nav_order: 1
---

### Using OFT From Java

The Java interface uses the "fluent programming" paradigm to make the code more compact and easy to read.
Expand Down
2 changes: 2 additions & 0 deletions doc/user_guide/product_lifecycle/product_lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Product Lifecycle
parent: User Guide
has_children: true
nav_order: 7
---

# Product Lifecycle
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/build_integration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Build Integration
parent: Reference
grand_parent: User Guide
nav_order: 2
---

### Build Integration

To integrate requirement tracing with OFT into your CI build, we recommend using the OFT plugins for Maven and Gradle:
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/console_tracing_report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Console Tracing Report
parent: Reference
grand_parent: User Guide
nav_order: 4
---

### Console Tracing Report

The Console Tracing Report is the standard report format of OFT. Its main purpose is to quickly debug broken tracing links. In this section you learn how to read this report.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/input_format_support.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Input Format Support
parent: Reference
grand_parent: User Guide
nav_order: 3
---

### Input Format Support

#### Tags in Programming Language or Markup Files
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/oft_command_line.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: OFT Command Line
parent: Reference
grand_parent: User Guide
nav_order: 1
---

### OFT Command Line

The OFT command line looks like this:
Expand Down
1 change: 1 addition & 0 deletions doc/user_guide/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Reference
parent: User Guide
has_children: true
nav_order: 4
---

## Reference
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/report_summary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Report Summary
parent: Reference
grand_parent: User Guide
nav_order: 5
---

### Report Summary

At the end of the report, a summary is displayed that informs you about the overall state of the trace.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/reference/xml_tracing_report.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: XML Tracing Report
parent: Reference
grand_parent: User Guide
nav_order: 6
---

### XML Tracing Report

Often users want to further process the results generated by OpenFastTrace to create statistics about requirements,
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/tool_support/templates_for_ides.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Templates for IDEs
parent: Tool Support
grand_parent: User Guide
nav_order: 2
---

### Templates for IDEs

You can create OpenFastTrace artifacts faster with templates for your IDE. See [the list of available IDE Templates](https://github.com/itsallcode/openfasttrace-ide-templates).
Expand Down
1 change: 1 addition & 0 deletions doc/user_guide/tool_support/tool_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Tool Support
parent: User Guide
has_children: true
nav_order: 6
---

## Tool Support
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Tools for Authoring OFT Documents
parent: Tool Support
grand_parent: User Guide
nav_order: 1
---

### Tools for Authoring OFT Documents

The following editors and integrated development environments are well suited for authoring OFT documents. The list is not exhaustive, any editor with Markdown capabilities can be used.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/delegating_requirement_coverage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Delegating Requirement Coverage
parent: Use Cases
grand_parent: User Guide
nav_order: 3
---

### Delegating Requirement Coverage

Consider a situation where you are responsible for the high-level software architecture of your project. You define the component breakdown, the interfaces and the interworking of the components. You get your requirements from a system requirement specification, but it turns out many of those incoming requirements are at a detail level that does not require design decisions on inter-component-level but rather affects the internals of a single component.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/distributing_the_detailing_work.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Distributing the Detailing Work
parent: Use Cases
grand_parent: User Guide
nav_order: 4
---

### Distributing the Detailing Work

In projects of a certain size you always reach the point where a single team is not enough to process the workload. As a consequence, the teams must find a way to distribute the work. A popular approach is splitting the architecture into components that are as independent as possible. Each team is then responsible for one or more distinct components. While the act of assigning the work should never be done inside the specification, at least the specification can prepare criteria on which to split the work.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Excluding Parts of a Specification Document for OFT Parsing
parent: Use Cases
grand_parent: User Guide
nav_order: 2
---

### Excluding Parts of a Specification Document for OFT Parsing

Sometimes you want specific sections or a whole document to be excluded from OFT parsing. One reason could be that it is a document that contains an OFT example, that should not contribute to the trace. Or, you could have data in a document and don't want to risk that something accidentally looks like an OFT artifact.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/filtering_by_status.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Filtering by Status
parent: Use Cases
grand_parent: User Guide
nav_order: 5
---

### Filtering by Status

Sometimes you only want to see specification items that have reached a certain maturity level. For example, you might want to create a report that only includes approved requirements.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/html_tracing_reports.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: HTML Tracing Reports
parent: Use Cases
grand_parent: User Guide
nav_order: 8
---

### HTML Tracing Reports

While plain text reports are perfect for debugging your tracing chain, sometimes you need reports that are more optically appealing. This is usually true if you have to show reports to management or to quality assessors who usually focus on summaries and statistics rather than detail results. In this case you can tell OFT to create reports in HTML format by adding the `-o html` switch.
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/tracing_the_whole_chain.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Tracing the Whole Chain
parent: Use Cases
grand_parent: User Guide
nav_order: 6
---

### Tracing the Whole Chain

If you plan to assess the coverage state of your product as a whole, you need to trace the full chain including all artifacts.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Tracing the Whole Chain in the Same File System
parent: Use Cases
grand_parent: User Guide
nav_order: 7
---

### Tracing the Whole Chain in the Same File System

Preconditions:
Expand Down
1 change: 1 addition & 0 deletions doc/user_guide/use_cases/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Use Cases
parent: User Guide
has_children: true
nav_order: 3
---

## Use Cases
Expand Down
8 changes: 8 additions & 0 deletions doc/user_guide/use_cases/writing_a_specification.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Writing a Specification
parent: Use Cases
grand_parent: User Guide
nav_order: 1
---

### Writing a Specification

Preconditions:
Expand Down
Loading
Loading