diff --git a/doc/spec/index.md b/doc/spec/index.md index 9fd20bc5..c2b81d46 100644 --- a/doc/spec/index.md +++ b/doc/spec/index.md @@ -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) diff --git a/doc/user_guide/installation/installation.md b/doc/user_guide/installation/installation.md index 3c0a5082..e0a9c2f0 100644 --- a/doc/user_guide/installation/installation.md +++ b/doc/user_guide/installation/installation.md @@ -3,6 +3,7 @@ layout: default title: Installation parent: User Guide has_children: true +nav_order: 2 --- ## Installation diff --git a/doc/user_guide/installation/linux.md b/doc/user_guide/installation/linux.md index c02aa3f2..7d952497 100644 --- a/doc/user_guide/installation/linux.md +++ b/doc/user_guide/installation/linux.md @@ -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. diff --git a/doc/user_guide/installation/macos.md b/doc/user_guide/installation/macos.md index afec2019..f8746308 100644 --- a/doc/user_guide/installation/macos.md +++ b/doc/user_guide/installation/macos.md @@ -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. diff --git a/doc/user_guide/installation/windows.md b/doc/user_guide/installation/windows.md index 2deb8898..fbb2fc70 100644 --- a/doc/user_guide/installation/windows.md +++ b/doc/user_guide/installation/windows.md @@ -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. diff --git a/doc/user_guide/introduction/concepts_and_terms.md b/doc/user_guide/introduction/concepts_and_terms.md index 71f7a336..82db5ef4 100644 --- a/doc/user_guide/introduction/concepts_and_terms.md +++ b/doc/user_guide/introduction/concepts_and_terms.md @@ -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). diff --git a/doc/user_guide/introduction/introduction.md b/doc/user_guide/introduction/introduction.md index 3b06eb36..85a4e6df 100644 --- a/doc/user_guide/introduction/introduction.md +++ b/doc/user_guide/introduction/introduction.md @@ -3,6 +3,7 @@ layout: default title: Introduction parent: User Guide has_children: true +nav_order: 1 --- ## Introduction diff --git a/doc/user_guide/introduction/what_is_requirement_tracing.md b/doc/user_guide/introduction/what_is_requirement_tracing.md index 39a5f42d..5792c4ac 100644 --- a/doc/user_guide/introduction/what_is_requirement_tracing.md +++ b/doc/user_guide/introduction/what_is_requirement_tracing.md @@ -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. diff --git a/doc/user_guide/introduction/who_should_read_this_document.md b/doc/user_guide/introduction/who_should_read_this_document.md index 6772debd..f19ffc73 100644 --- a/doc/user_guide/introduction/who_should_read_this_document.md +++ b/doc/user_guide/introduction/who_should_read_this_document.md @@ -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. diff --git a/doc/user_guide/introduction/why_do_i_need_requirement_tracing.md b/doc/user_guide/introduction/why_do_i_need_requirement_tracing.md index 379cd1e3..ddae9b4f 100644 --- a/doc/user_guide/introduction/why_do_i_need_requirement_tracing.md +++ b/doc/user_guide/introduction/why_do_i_need_requirement_tracing.md @@ -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: diff --git a/doc/user_guide/oft_api/exit_codes.md b/doc/user_guide/oft_api/exit_codes.md index 6ec1e4e3..dea3f383 100644 --- a/doc/user_guide/oft_api/exit_codes.md +++ b/doc/user_guide/oft_api/exit_codes.md @@ -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: diff --git a/doc/user_guide/oft_api/oft_api.md b/doc/user_guide/oft_api/oft_api.md index 01dae301..a4fd0e1b 100644 --- a/doc/user_guide/oft_api/oft_api.md +++ b/doc/user_guide/oft_api/oft_api.md @@ -3,6 +3,7 @@ layout: default title: OFT API parent: User Guide has_children: true +nav_order: 5 --- ## OFT API diff --git a/doc/user_guide/oft_api/using_oft_from_java.md b/doc/user_guide/oft_api/using_oft_from_java.md index 7a62d806..e3cc9eb6 100644 --- a/doc/user_guide/oft_api/using_oft_from_java.md +++ b/doc/user_guide/oft_api/using_oft_from_java.md @@ -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. diff --git a/doc/user_guide/product_lifecycle/product_lifecycle.md b/doc/user_guide/product_lifecycle/product_lifecycle.md index 5a8ec8a7..854fbcdf 100644 --- a/doc/user_guide/product_lifecycle/product_lifecycle.md +++ b/doc/user_guide/product_lifecycle/product_lifecycle.md @@ -2,6 +2,8 @@ layout: default title: Product Lifecycle parent: User Guide +has_children: true +nav_order: 7 --- # Product Lifecycle diff --git a/doc/user_guide/reference/build_integration.md b/doc/user_guide/reference/build_integration.md index c4b14444..3f0943a9 100644 --- a/doc/user_guide/reference/build_integration.md +++ b/doc/user_guide/reference/build_integration.md @@ -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: diff --git a/doc/user_guide/reference/console_tracing_report.md b/doc/user_guide/reference/console_tracing_report.md index c268a2fd..24db2620 100644 --- a/doc/user_guide/reference/console_tracing_report.md +++ b/doc/user_guide/reference/console_tracing_report.md @@ -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. diff --git a/doc/user_guide/reference/input_format_support.md b/doc/user_guide/reference/input_format_support.md index f58c520f..737869ba 100644 --- a/doc/user_guide/reference/input_format_support.md +++ b/doc/user_guide/reference/input_format_support.md @@ -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 diff --git a/doc/user_guide/reference/oft_command_line.md b/doc/user_guide/reference/oft_command_line.md index 1c14e039..57f262e7 100644 --- a/doc/user_guide/reference/oft_command_line.md +++ b/doc/user_guide/reference/oft_command_line.md @@ -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: diff --git a/doc/user_guide/reference/reference.md b/doc/user_guide/reference/reference.md index d3cc8f8b..c98adcce 100644 --- a/doc/user_guide/reference/reference.md +++ b/doc/user_guide/reference/reference.md @@ -3,6 +3,7 @@ layout: default title: Reference parent: User Guide has_children: true +nav_order: 4 --- ## Reference diff --git a/doc/user_guide/reference/report_summary.md b/doc/user_guide/reference/report_summary.md index 7c8cae17..302f6303 100644 --- a/doc/user_guide/reference/report_summary.md +++ b/doc/user_guide/reference/report_summary.md @@ -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. diff --git a/doc/user_guide/reference/xml_tracing_report.md b/doc/user_guide/reference/xml_tracing_report.md index 7a15bd9f..53f26032 100644 --- a/doc/user_guide/reference/xml_tracing_report.md +++ b/doc/user_guide/reference/xml_tracing_report.md @@ -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, diff --git a/doc/user_guide/tool_support/templates_for_ides.md b/doc/user_guide/tool_support/templates_for_ides.md index 766cb14f..8d9206b6 100644 --- a/doc/user_guide/tool_support/templates_for_ides.md +++ b/doc/user_guide/tool_support/templates_for_ides.md @@ -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). diff --git a/doc/user_guide/tool_support/tool_support.md b/doc/user_guide/tool_support/tool_support.md index 50a81534..77e723fa 100644 --- a/doc/user_guide/tool_support/tool_support.md +++ b/doc/user_guide/tool_support/tool_support.md @@ -3,6 +3,7 @@ layout: default title: Tool Support parent: User Guide has_children: true +nav_order: 6 --- ## Tool Support diff --git a/doc/user_guide/tool_support/tools_for_authoring_oft_documents.md b/doc/user_guide/tool_support/tools_for_authoring_oft_documents.md index af85412a..acd469f8 100644 --- a/doc/user_guide/tool_support/tools_for_authoring_oft_documents.md +++ b/doc/user_guide/tool_support/tools_for_authoring_oft_documents.md @@ -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. diff --git a/doc/user_guide/use_cases/delegating_requirement_coverage.md b/doc/user_guide/use_cases/delegating_requirement_coverage.md index 84130a48..905a5c75 100644 --- a/doc/user_guide/use_cases/delegating_requirement_coverage.md +++ b/doc/user_guide/use_cases/delegating_requirement_coverage.md @@ -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. diff --git a/doc/user_guide/use_cases/distributing_the_detailing_work.md b/doc/user_guide/use_cases/distributing_the_detailing_work.md index 03c2727a..8f4a5b40 100644 --- a/doc/user_guide/use_cases/distributing_the_detailing_work.md +++ b/doc/user_guide/use_cases/distributing_the_detailing_work.md @@ -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. diff --git a/doc/user_guide/use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md b/doc/user_guide/use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md index a92e6746..4b97479a 100644 --- a/doc/user_guide/use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md +++ b/doc/user_guide/use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md @@ -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. diff --git a/doc/user_guide/use_cases/filtering_by_status.md b/doc/user_guide/use_cases/filtering_by_status.md index 14d37021..9774b377 100644 --- a/doc/user_guide/use_cases/filtering_by_status.md +++ b/doc/user_guide/use_cases/filtering_by_status.md @@ -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. diff --git a/doc/user_guide/use_cases/html_tracing_reports.md b/doc/user_guide/use_cases/html_tracing_reports.md index b0b3177a..79b091e0 100644 --- a/doc/user_guide/use_cases/html_tracing_reports.md +++ b/doc/user_guide/use_cases/html_tracing_reports.md @@ -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. diff --git a/doc/user_guide/use_cases/tracing_the_whole_chain.md b/doc/user_guide/use_cases/tracing_the_whole_chain.md index 5a42df73..62f4c23a 100644 --- a/doc/user_guide/use_cases/tracing_the_whole_chain.md +++ b/doc/user_guide/use_cases/tracing_the_whole_chain.md @@ -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. diff --git a/doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md b/doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md index 32b7c524..61b94a07 100644 --- a/doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md +++ b/doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md @@ -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: diff --git a/doc/user_guide/use_cases/use_cases.md b/doc/user_guide/use_cases/use_cases.md index 17993bb7..b062a67e 100644 --- a/doc/user_guide/use_cases/use_cases.md +++ b/doc/user_guide/use_cases/use_cases.md @@ -3,6 +3,7 @@ layout: default title: Use Cases parent: User Guide has_children: true +nav_order: 3 --- ## Use Cases diff --git a/doc/user_guide/use_cases/writing_a_specification.md b/doc/user_guide/use_cases/writing_a_specification.md index d23711a5..8557d059 100644 --- a/doc/user_guide/use_cases/writing_a_specification.md +++ b/doc/user_guide/use_cases/writing_a_specification.md @@ -1,3 +1,11 @@ +--- +layout: default +title: Writing a Specification +parent: Use Cases +grand_parent: User Guide +nav_order: 1 +--- + ### Writing a Specification Preconditions: diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md index 05d916aa..4a9d17dc 100644 --- a/doc/user_guide/user_guide.md +++ b/doc/user_guide/user_guide.md @@ -16,43 +16,3 @@ OFT is a requirement tracing tool. It helps you make sure that all defined requi 1. Create requirement and specification documents in Markdown, including OFT-readable specification items 2. Put tags into your source code that mark the coverage of items from the specification 3. Use OFT to trace the requirements from the source to the final implementation - -## [Introduction](introduction/introduction.md) -* [Who Should Read This Document?](introduction/who_should_read_this_document.md) -* [What is Requirement Tracing?](introduction/what_is_requirement_tracing.md) -* [Why do I Need Requirement Tracing?](introduction/why_do_i_need_requirement_tracing.md) -* [Concepts and Terms](introduction/concepts_and_terms.md) - -## [Installation](installation/installation.md) -* [Linux Installation](installation/linux.md) -* [macOS Installation](installation/macos.md) -* [Windows Installation](installation/windows.md) - -## [Use Cases](use_cases/use_cases.md) -* [Writing a Specification](use_cases/writing_a_specification.md) -* [Excluding Parts of a Specification Document for OFT Parsing](use_cases/excluding_parts_of_a_specification_document_for_oft_parsing.md) -* [Delegating Requirement Coverage](use_cases/delegating_requirement_coverage.md) -* [Distributing the Detailing Work](use_cases/distributing_the_detailing_work.md) -* [Filtering by Status](use_cases/filtering_by_status.md) -* [Tracing the Whole Chain](use_cases/tracing_the_whole_chain.md) -* [Tracing the Whole Chain in the Same File System](use_cases/tracing_the_whole_chain_in_the_same_file_system.md) -* [HTML Tracing Reports](use_cases/html_tracing_reports.md) -* [Understanding and Fixing Broken Requirement Branches](use_cases/understanding_and_fixing_broken_requirement_branches.md) - -## [Reference](reference/reference.md) -* [OFT Command Line](reference/oft_command_line.md) -* [Build Integration](reference/build_integration.md) -* [Input Format Support](reference/input_format_support.md) -* [Console Tracing Report](reference/console_tracing_report.md) -* [Report Summary](reference/report_summary.md) -* [XML Tracing Report](reference/xml_tracing_report.md) - -## [OFT API](oft_api/oft_api.md) -* [Using OFT From Java](oft_api/using_oft_from_java.md) -* [Exit Codes](oft_api/exit_codes.md) - -## [Tool Support](tool_support/tool_support.md) -* [Tools for Authoring OFT Documents](tool_support/tools_for_authoring_oft_documents.md) -* [Templates for IDEs](tool_support/templates_for_ides.md) - -## [Product Lifecycle](product_lifecycle/product_lifecycle.md)