Search

Authoring Tools (RAT)

Authoring Tools

A SMARTer way to document your system

Tools and plug-ins to assist you in the activity of writing requirements and other natural language texts.

Performs Correctness and Consistency analysis on the fly

Suggests controlled-vocabulary items based on a central knowledge base

Fully integrated into your Requirements Management Tool and Modelling Tool

  

Requirements Authoring Tool: authoring requirements inside RMSs

Rhapsody Authoring Tool: authoring requirements and models inside IBM Rhapsody


The Requirements Authoring Tool (RAT) is the smarter way to write requirements, test cases, definition of risks… and any other concise statement that should be written following an agreed-upon structure, following a set of quality rules, and using the terms coming from a controlled vocabulary.

Authors of systems documentation must know what structure to follow, which terms to use, the expected quality policies or checklist to follow, the level of consistency with other requirements or models... That is why writing new requirements can sometimes lead to a writer’s block.

Requirements Authoring Tool (RAT) is the perfect assistant for system analysts/engineers when writing the system documentation. RAT leads engineers with a set of agreed-upon patterns, suggests the most suitable content for each piece of information written and always ensures the right grammar, with quality checking on real time. RAT exonerates engineers from format concerns (e.g. structure of requirements) and allow them to concentrate on the content (essence of requirements), that is, the technical data useful for design.

Once a pattern has been selected, RAT shows its structure, its description and examples of how it should be used, either for a requirement, a model or other work-products. Authors just need to select the right terms and semantics from a controlled vocabulary suggested while typing, thus ensuring that the developed requirement, or other artifact, has followed the right grammar and it provides the proper information.

RAT implements an IntelliSense way of writing – a technique that guides authors while writing – thus providing an accurate way of creating consistent requirements and speeding up system documentation writing.

Applying this SMARTer way to develop the system documentation, RAT entitles several benefits:

  • The system assets include the right pieces of information (Completeness).
  • Both humans and computers will read and understand textual requirements more easily without ambiguity (Correctness).
  • The SKM Semantic Retrieval Engine “understands” the information stated in one single way (Reuse and Formalization).
  • The chances of finding coupled or inconsistent work-products are increased (Consistency).
  • Homogeneous vocabulary and grammar across all the documents improve the consistency of the whole specification.

The information reported by RAT includes out-of-the-box quality metrics for the detection of inconsistences, ambiguity, or duplicated requirements or models. The real-time quality assessment, as well as the IntelliSense writing assistant are both included as plug-ins on top of some of the most widely used requirements management and modelling tools.

Benefits

Quality RAT offers the same quality analysis provided by V&V Studio, but now in an on-the-fly basis (real time). Best practices, checklists, rules, etc., are now closer to document writers in systems engineering projects.

Time - The concept “Right the first time” can now be applied to the writing of requirements, test cases etc. RAT allows a dramatic drop in terms of the number of verification loops at different levels.

Money - Reducing rework has a significant impact on saving money in all sorts of projects. In the earlier stages, we make most of the financial decisions regarding the project. Focusing on requirements quality from the very beginning really pays dividends.

 Rich Authoring Tool