Among the documents to export from arKItect, you can find the Technical Specification. This document allows you to export a Word file with the detail of all of the requirements of one or multiple Subsystems or Components. You may choose the Component(s), and consequently a Word document will generate showing all of the requirements within them.
The Technical Specification will contain a Table of Contents that will look similar to this:
1.2. Document references
1.3. Terminology: definitions and abbreviations
2.2. Context diagram
2.3. Functional interfaces diagram
2.4. Physical interfaces diagram
3.1. Requirement 1
3.2. Requirement 2
The document will show the Requirements that are, either directly allocated (to the selected Components), or belonging to the functions directly allocated to each of the selected components. This is represented in the following scheme:
The “Introduction” attribute will be shown for the Title requirements, which will serve as an introductory paragraph to the requirement.
For all of the other Requirements that appear as tables in the Technical Specification, you will see the comments, as well as some other relevant attributes.
The Requirement's table should look similar to this:
More or less information will appear, depending on the completed fields on the Object's properties.
Technical Specification Generation Procedure:
Now we will generate the Technical Specification document. There are certain steps to take into account to be able to this.
First of all, you will have to change the type of all the requirements you wish to appear at the Table of Contents (as chapters).
We will use the Laptop exercise to exemplify this procedure.
In order to do this, you may go to the view 2.1 “Define Requirements”.
You will modify the type of requirement for all of those that you wish to include as chapters in the Technical Specification. In our example, we will select the requirement “OS and Laptop Power”.
Once selected, click on the “Object Properties” button.
A window will appear with all of the requirement’s properties.
The type is going to be: “Title”. As a result, these requirements will be shown as chapters in the Technical Specification, and will not appear as Tables inside the document.
In the Attributes section of the properties, under main, you will find “Requirement type (Enum)”. Next to it, you will be able to choose from all the different types of existing requirements. Select the type “Title”. You may repeat this step for all of the requirements wished to appear as chapters in the Technical Specification document.
For the Title Requirements:
- The Requirements within them (Sub-requirement) who’s type is also changed to Title, will appear as a sub-chapter within the document, and not in the Table of Contents.
- The Introduction attribute, located at the Object's Properties / Export formatting / Introduction (Rich text), will serve as an introductory paragraph to the requirement. This rich text may contain special characteristics such as format, images (copied and pasted), and length.
In the Technical Specification document, we will also see the attached documents to the requirements. Depending on the type of document, they will appear directly on the document, or be referenced by name on the requirement’s table.
In the same view 2.1 “Define Requirements”, we will add attachments to some requirements, so that they will appear in our Technical Specification.
Find the following 2 requirements:
- Battery Autonomy
- Battery Heating
Go to both requirements’ “Object Properties”, and under Attributes – Attachment (Saved File), add different attachments, with different types. We may add any photo we have saved in our Images folder, as well as a document (Word, Excel, Power Point…). Remember that this step is not mandatory to produce the Technical Specification. We are trying to cover several different possibilities with our example.
It is also worth noting that if a Variant is selected, it will serve as a filter for the Requirements shown in the Technical Specification Document.
Now we are ready to generate the Technical Specifications Document. To do so, we will go to the view 5.1. Allocate Functions on Components. (You may also find the script on the Process view)
Once there, we will click on Project Tools, to display all of the document generation tools.
The Project Tools Menu will display. Then, click on Document Generation Tools, followed by Technical Specification.
If there are pending Object Revisions (marked with *), the Objects Under Revision Control menu will appear, in order to advise you to create revisions to those objects with pending changes that have not been included to a new revision.
While this step is optional, we strongly advise you to create a revision, in order to always have the trace for the changes you have made in the objects.
You may apply changes under the Objects Under Revision Control, and then click on Close to continue.
If there are no pending revisions, or after you close Objects Under Revision Control, the following window will display:
You may select the template on Standard Template. We will choose a Word document as template.
Afterwards, it is necessary to select the Component(s) (or Subsystem(s)), for which the Technical Specification will be generated.
You will be able to select all, one or multiple components.
If you wish to select all of the components, click on "All" in Choose export target.
Otherwise, if you wish to select one or multiple components click on Select.
A window will display, where you will select the Component(s). Click on Ok to continue. In our Laptop example, we will select Battery, Graphical Card and Network Card.
You may now click on Run.
The Technical Specification document will begin to generate. You may wait a few minutes for the process to be finished. A word document will open.
Once the process is completed, you may verify the Technical Specification in the Word document.
The Technical Specification, for our Laptop example, with the Battery, Graphical Card and Network Card Components, should look like this:
The Knowledge Inside and Skype Logos were attached images to some requirements. Also, we will find the references to other files attached; such is the case for the Test.docx, files added in our example (you may see your very own file’s names under the requirement’s table).
arKItect will allow us to export the requirement’s files with our Technical Specification. To do that, we may go back to Project Tools – Document Generation Tools – Technical Specification. Once there, we will select the Component(s) (Battery for example), and tag on Export Attached Files. Click on Browse to select the Folder Path where you wish the attached files to be saved in.
A browser window will open on the chosen path, with the Word document containing the Technical Specification, as well as a folder named “files”, with all of the attached documents.