Document, document templates, context elements

Documents such as project orders or specifications belong in every project and are often the basis for communication between the project members. The project templates in objectiF RM already contain finished documents and document templates that you can use or adapt to your needs. Once you have familiarized yourself with document generation, you can also create your own documents and document templates.

Document template

You need document templates to create documents. You determine the content and display of the data that is later generated in the document. Once you have created document templates, you can use them as chapters in a (main) document template as often as you like. Examples of this are the glossary as well as the illustration and table directory. These are created only once and included in each document as referenced chapters. To create complex documents, you need a number of document templates, which are merged into one document at the end by different chapters. You design the document templates in MS Word. When you create documents and document templates, you encounter four stereotypes:

• A document has the stereotype «Document».
• You can recognize document templates by their stereotypes «DocumentTemplate»
• Referenced chapters receive the stereotype «DocumentComposition» and
• Chapters that are referenced in a document template have the stereotype «DocumentTemplateComposition».

Documents

Documents are based on document templates. The project templates provide you with the following documents in each project.

• Requirements definition
• Backlog & sprint status
• Goals and context
• Vision dokument
• System architecture
• Requirements specification
• Project strategy

You can use or customize the documents and templates. If you create a new document based on one of the following document templates, you only have to set the context elements for the individual chapters.

If you create a new document and select a template that has chapter templates, the new document is automatically created including all chapters.

Context elements

You use the context element to determine which elements are to be generated in the document. In most cases, you select a package that contains the requirements, stakeholders, test cases, and so on. If you cannot navigate to the required package, check that the package you want to assign matches the package in the template. Once you have set the context elements, you can change them later without having to recreate the document.

Create table of contents

Each document needs a table of contents. You define the table of contents in the first document template of a new document – the cover page.  The table of contents is based on the headings that you define in the document.

1. Create a new document template for the cover page and open it in MS Word using the Edit context menu command. The first page is your cover page, which you can design as you wish. On the second page, insert the table of contents.
2. In MS Word, switch to the References/Table of Contents tab.
3. Click on a table of contents that is generated automatically and insert it into the document.

4. Customize the styles and save the document. The styles you have defined here are automatically passed on to the following chapters, so that the table of contents and chapter headings are identical.

Create list of figures/ tables

All supplied documents in objectiF RM contain an image and table directory at the end. The table of figures lists all diagrams that appear in the document by name. The table directory, on the other hand, lists all embedded queries by name. If you do not need the list of diagrams and queries, delete the chapters from the document template.

If you want to have the chapters “List of figures and/or tables” in a new document, select the document template and choose the command Create / Assign chapter template from the context menu. If you want to add the two chapters to a document, select the Create other/ Chapter Template command from the context menu.

Create figure/ table

First you have to define what a directory is in the document template.

1. Create a new document template or open an existing one that should display a map/table directory in the future.
2. Open the document template via the context menu command Edit.
   MS Word opens.
3. Insert a diagram, a query etc. into the template by clicking the Query/Diagram tab, selecting an element and clicking Insert below.
   If the bookmark editor is not open, activate it from the View/Document Actions menu bar.

4. In MS Word, switch to the References/ Insert Caption tab.
5. Select a label from the dropdown menu behind Label. You can create your own label by choosing New Label.

6. Insert them into the document via OK.

7. Insert them into the document via OK. Label diagrams with the placeholder Name so that the name of the diagram can later be generated in the directory of illustrations. For queries, you can specify the name of the query directly, since the table will not change, only the content.
8. Under Edit Bookmarks, switch to the Property tab, select Name, and then click Insert.
9. Before you save the document, format the label.

Creating chapter “List of figures and tables

1. Create or open a document template that will later output the directories.
2. In MS Word, switch to the References tab and click on Table of contents.
3. In the following dialog, you can adjust the display and select the corresponding directory of illustrations or tables under General/Labelling Category, depending on whether you want to create a directory of illustrations or a directory of tables.

Glossary

Each supplied document has a chapter that generates all glossary entries in the document. For new documents, use the document template Glossary, which can be found in the Settings window under Settings / Document Templates / Chapters.

• Open a document template and switch to the Glossary tab under Bookmarks.
• Click on Insert and save the template.