Leverage the capabilities of Innoslate's Documents View features to enhance requirements management and analysis.
Auto Number a Document | How to Auto Number a document. |
Baseline a Document | Baseline a document to establish a reference point. |
Save a Document Template | Save your document's template to reference in a new document. |
Acronym Extraction for Reference | Extract Acronyms in a document for team reference. |
Find & Replace | Find and Replace text for easy editing. |
Below we will explore the various features available under the 'More' option in Documents View.
Auto Number
Auto numbering in Innoslate allows for the application of sequential numbers to entities within a Document, based on their hierarchical structure. This feature can be accessed by clicking on the 'More' dropdown in Documents View. Once selected, a pop-up window will appear, allowing users to specify the starting number (defaults to 1 if left blank) and add a prefix, or choose to only add a prefix to the existing numbering scheme of the document.
Note this will only add to the number field of an entity. To find and replace within the number field, use the Find and Replace feature.
Users may also use the Auto Number feature for just a certain section of the document by clicking on a parent entity within the document and clicking on 'More' then 'Auto Number.' Doing so will bring up the following window so users may selecto to re-number and/or add a prefix for that particular section of the document:
Users may also use the filter on the left sidebar to auto number those shown entities.
Baseline a Document
Creating a baseline for a document captures a snapshot of the document's entities, relationships, and attributes. To create a baseline, select the 'Baseline' option under the 'More' button on the top toolbar. Please note, only users who have the role of 'Owner' in the project are able to create a baseline for a document.
A pop up will appear to name the baseline.
The entities in the document will be marked with blue baseline indicators to indicate that the document has been baselined.
Review an Existing Document Baseline
To review an existing document baseline, refer to the Baselines Tab on the left sidebar as circled in the image below.
In the Baselines section, users will find a list of their baselines along with their creation date and time, as indicated by the red arrow. By clicking on a baseline, users will be able to view all statement and requirement entities, including their relationships and attributes, for that version of the document. It's important to note that all baselines are displayed as read-only and cannot be edited. To resume editing a document, simply switch back to the current version by clicking on the top document link under Main Document, indicated by the red square in the image.
Document Template
Innoslate's 'Template' feature allows users to save a document format for easy recall when creating new documents. This functionality empowers users to uphold uniformity across various documents, eliminating the need to recreate redundant information.
To get started, select 'Template' in the 'More' dropdown of Documents View.
Delete a Custom Template
When you create a template, there is an Artifact entity created with the template name, like shown below.
Delete that artifact entity and it will remove the custom template from the dropdown during document creation.
Acronym Extractor
The Acronym Extractor feature in Innoslate enables users to extract all acronyms from a current document and compile them into a separate document, along with their corresponding full names.
Select the ‘Acronym Extractor’ button located in the menu of the document.When users select the 'Acronym Extractor' option, a popup will appear, allowing users to choose the 'Extraction Options' and the 'Confidence Level' under the 'Setup' tab. The 'Extraction Options' determine which fields the extractor will use to extract acronyms from the document's entities. While the extractor will display all acronyms for the corresponding confidence level, the 'Confidence Level' selected in this step will be the one initially displayed in step 3.
- A 95% Confidence level means that the acronym is found multiple times in the document with a possible detected definition.
- A 65% Confidence level means that an acronym is found once with a possible detected definition.
- A 40% Confidence level means that an acronym was found but there was not a definition detected with it.
In the ‘Generate’ tab there are to apply to the selected acronyms, such as where they will be stored, the traceability of the acronyms, and hyperlink the chosen acronyms to the acronym document.
- Under ‘Acronym Document’ users can select which document to add the acronyms to. Those options include adding acronyms to that specific document’s acronym document or to an overall project’s acronym document.
- Under ‘Traceability’ users can select to create traceability from the acronyms to the current document to the acronym document.
- Under ‘Hyperlinks Creation’ users can select to create hyperlinks to those acronyms in the document.
Upon selecting the 'Create' button, Innoslate users will be redirected to the Acronyms Document, where they will find all of the acronyms they have selected.
Find and Replace
The 'Find and Replace' feature allows Innoslate users to find and replace certain words or phrases within the document.
Click 'Apply' once complete and the replacement will execute.
To continue learning about Documents View, Click Here.
(Next Article: Documents View Settings & Search)