Lab 3: Creating a module and converting it to a template

373 views
289 views

Published on

(Module: Modules as requirement specifications)
At the end of this lab you will be able to:
► Create a new module
► Create new artifacts inside a module
► Hierarchically organize artifacts within a module
► Create a module template
► Remove an artifact from a module
► Create a module from a template
Given
► Automated Meter Reader (Water) project (AMR)
Description
► In this lab, you create a template for a vision document that the team will use. The team already created templates for a hardware requirements specification and a software requirements specification.
Exercise tasks
In this exercise, you complete these tasks:
► Task 1: Create a module artifact
► Task 2: Add new artifacts to the vision document and create sections
► Task 3: Organize artifacts hierarchically by using promote and demote
► Task 4: Move sections within the module
► Task 5: Remove and delete a new artifact
► Task 6: Create a template
► Task 7: Locate the base artifacts
► Task 8: Create a module from a template

Published in: Education, Technology, Business
0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
373
On SlideShare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
0
Comments
0
Likes
2
Embeds 0
No embeds

No notes for slide

Lab 3: Creating a module and converting it to a template

  1. 1. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template© Copyright IBM Corp. 2013 1Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Lab 3: Creating a module and converting it to atemplateObjectivesAt the end of this lab you will be able to:► Create a new module► Create new artifacts inside a module► Hierarchically organize artifacts within a module► Create a module template► Remove an artifact from a module► Create a module from a templateGiven► Automated Meter Reader (Water) project (AMR)Description► In this lab, you create a template for a vision document that the team will use. The team already createdtemplates for a hardware requirements specification and a software requirements specification.► The final vision document template should look like this example:Figure 1: Example of vision document template
  2. 2. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template2 © Copyright IBM Corp. 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Exercise tasksIn this exercise, you complete these tasks: Task 1: Create a module artifact Task 2: Add new artifacts to the vision document and create sections Task 3: Organize artifacts hierarchically by using promote and demote Task 4: Move sections within the module Task 5: Remove and delete a new artifact Task 6: Create a template Task 7: Locate the base artifacts Task 8: Create a module from a template
  3. 3. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template© Copyright IBM Corp. 2013 3Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Task 1: Create a module artifact1. You are in the lab environment All Projects page of the RM application (https://jazz-server:9443/rm/web). You are logged in as bob with password bob.2. Navigate to the Automated Meter Reader (Water) project Artifact page.3. In the Automated Meter Reader (Water) project, open the Module Template folder. Notice the two templates:a. Hardware Requirements Specification Templateb. Software Requirements Specification Template4. From the edit options of the Module Template folder, click Create.5. In the “Create an artifact with attributes” window, provide information about the new artifact:a. Name: Vision Document Templateb. Artifact type: Requirements Specificationc. For the artifact format, ensure that the default format, which is Module, is selected.d. For the description, type Template for vision documentse. Ensure that the folder location is Module Template.f. Select the Open Artifact check box.Figure 2: Information about the new vision document template
  4. 4. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template4 © Copyright IBM Corp. 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.6. Click Finish. The vision document template opens for editing.Figure 3: New moduleTask 2: Add new artifacts to the vision document and create sections1. From the navigation section of the module, click the arrow on the Create Artifact button, and ensure that theUse One-click create check box is cleared. When that check box is cleared, you can create an artifact in aspecific location. Later, you will select the Use One-Click Create check box to continue creating similarartifacts quickly.Figure 4: The Use One-Click Create check box is cleared2. From the main content of the module, click Create New Artifacts.3. In the “Create an arifact with attributes” window, provide information about the new artifact:a. Name: Introduction
  5. 5. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template© Copyright IBM Corp. 2013 5Course materials may not be reproduced in whole or in part without the prior written permission of IBM.b. Artifact Type: Informationc. Artifact Format: Textd. Ensure that the folder location is Vision Document Template artifacts.Figure 5: Information about the new Introduction artifact4. Click Finish. The new artifact is displayed in the module.5. From the edit menu of the artifact you just create, select Display as Heading.Figure 6: The Display as Heading menu itemThe artifact becomes a numbered section.
  6. 6. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template6 © Copyright IBM Corp. 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Figure 7: The artifact is displayed as a numbered section6. Select section 1 and expand the edit menu. From the menu, click Create New Similar (information) > Below(as a Child). A new artifact is displayed in the module.7. In the new module, type Summary of this project and why we are doing it. Because youcreated a similar artifact, this artifact is a heading. While you are editing the artifact, press Ctrl+H to change theartifact from a heading to non-heading text.8. Press Ctrl+N to create another similar artifact after the current artifact.9. In the new artifact, type Intended Use. While you are editing the artifact, press Ctrl+H to display theartifact as a heading.10. Press Ctrl+N to create the following artifacts, all of which are headings:a. Business Goalsb. Vision Statementsc. Scoped. Product Solutione. Special RequestsYour module should now look like this example:Figure 8: A module with 8 artifacts that still need some hierarchical organization
  7. 7. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template© Copyright IBM Corp. 2013 7Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Task 3: Organize artifacts hierarchically by using promote and demote1. Select 1.4 Scope and 1.5 Product Solution, and from the Edit option of one of the selected artifact, selectdemote.Figure 9: Demote two artifacts2. Select sections 1.2, 1.3, and 1.4 and from the edit options of one of the selected artifact, select PromoteArtifacts.Task 4: Move sections within the moduleMove section 3, Vision Statements, and its two hierarchical children to come after the current section 4, SpecialRequests. This task documents only one of several ways that you can move sections.1. Select the check box for section 3, Vision Statement, and from its edit menu, click Cut Artifact.Figure 10: Select section 3, and Cut the artifact.
  8. 8. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template8 © Copyright IBM Corp. 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.2. From the edit option of section 4. Special Requests, select Paste Special.3. In the Past Special window, select Paste selection after this artifact. The resulting outline should look like thisexample:Figure 11: The Vision Statements section is moved after the Special Requests sectionTask 5: Remove and delete a new artifactThe Special Requests section does not belong in the vision document. That section is part of the stakeholderrequirements. Remove the section and delete the artifact from the module1. From within the module, open the section 3. Special Requests artifact. Notice that this requirement is not usedin other areas.TIP: In addition to modules, an artifact can be part of collections. Such information would not appear in the richhover of the artifact.Figure 12: The In Module section shows that the artifact is used in one module
  9. 9. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template© Copyright IBM Corp. 2013 9Course materials may not be reproduced in whole or in part without the prior written permission of IBM.2. Use the breadcrumbs to return to the Vision Document Template module.3. From the edit menu of Section 3, Special Requests, click Remove Artifact.4. Confirm that you are removing the artifact from the module. When you remove an artifact, it is not deleted.The artifact still exists as a base artifact.5. Delete the base artifact by clicking Delete. You can delete the base artifact because this artifact was not used inother modules. After the deletion, the subsequent sections are renumbered.Task 6: Create a templateYou can now finalize the module and create a template.1. From the upper-right corner of the module, click the Create Artifact Template icon.Figure 13: The Create Artifact Template icon2. In the New Artifact Template window, provide information about the new artifact:a. Ensure that the name of the template is Vision Document Templateb. For the duplication policy, select Duplicate no artifacts (re-use all artifacts). This option implies reuse.3. Click Create, and then click Close.
  10. 10. Student Workbook Module: Modules as requirement specificationsLab 3: Creating a module and converting it to a template10 © Copyright IBM Corp. 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Task 7: Locate the base artifacts1. Return to the Module Templates folder by using the breadcrumbs.2. Find the Vision Document Template that Bob created, and then navigate to the Vision Document Templateartifacts folder.3. Observe the base artifacts that were created and are used in the module.Task 8: Create a module from a template1. Navigate to the 01 Requirements folder.2. Click the arrow on the Create Artifact button and select Requirements Specification3. In the “Create an artifact with attributes” window, provide the following information:a. For the name, type Test Vision templateb. For the Template, select Vision Document Template.c. Select the Open Artifact check box.Figure 14: Creating a module from a template4. Click Finish.5. After the module is displayed, open an artifact and observe which modules it is used in.Figure 15: The In Module section shows two modules6. Use the breadcrumbs to return to the Test Vision template module, and then to 01 Requirements folder.7. Find the Test Vision template and delete it from the project by using its edit menu.

×