Organizing requirements information

441 views

Published on

After you complete this module, you should be able to do these tasks :
– Explain the advantages and disadvantages of these artifact organization options:
-– Folders
-– Collection artifacts
-– Text artifacts
-– Module artifacts
– Tag artifacts
– Organize requirements by using folders

Published in: Education, Technology
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

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

No notes for slide

Organizing requirements information

  1. 1. 1© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information© Copyright IBM Corporation 2013Organizing requirements informationContentsModule overview -2Folders -3Views: Get different perspectives of data -5Collection artifact -6Text artifacts -7Module artifact -8Tags -11Creating tags -12Adding tags to an artifact -13Adding tags to a group of artifacts -14Summary of benefits -15Lab 1: Working with Folders -16Lab 2: Creating and applying tags -17Lab 3: Optional: Creating views at the modulelevel -18Review -19Module summary -20
  2. 2. 2© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information2 © Copyright IBM Corporation 2013Module overviewAfter you complete this module, you should be able todo these tasks : Explain the advantages and disadvantages of these artifactorganization options:– Folders– Collection artifacts– Text artifacts– Module artifacts Tag artifacts Organize requirements by using folders
  3. 3. 3© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.3 © Copyright IBM Corporation 2013Folders• Exist at the project level• Organize requirements artifacts into a logical structure• Along with sub-folders, can represent artifact hierarchies orprovide an organizing structure for a project or programTeam members with author oradministrator privileges can dothese activities: Move artifacts between folders Move folders within the project Create folders Rename folders Delete foldersWhen you create a project from a template,folders can be predefined and createdautomatically .Team members with author or administratorprivileges can do these activities:• Move artifacts between folders• Move folders within the project• Create folders• Rename folders• Delete foldersAt the project level, artifacts can be organized infolders•Advantages:• Folders organize artifacts in lists.• Folders represent artifacts in theform of a spreadsheet, one artifactper row and attributes displayed incolumns• You can display and edit artifactcontent, attributes, and links incolumns.• You can sort artifacts by content,attribute, and link information.• You can filter information byattribute and link information.• Folders and subfolders can providean ordered, logical structure for aproject.• You can get different perspectives ofthe data in a folder by using views.•Disadvantages• Folders lack peripheral andsupporting information.• Folders lack continuity ofinformation that is hierarchical andstructured.• An artifact can exist in only onefolder.Organizing requirements information
  4. 4. 4© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.4 © Copyright IBM Corporation 2013Folders for access control• Permissions can beassigned at the projector team level.• Team-levelpermissions providegranular control overwho can create andmodify artifacts,folders, attributes, andlinks.• Team ownership canbe assigned at thefolder level to controlwho can modifyartifacts in that folder.All members of the project have read-accessto project artifacts. Read-access cannot berestricted for project members.Write permissions can be assigned at theproject level or at a team level. For moregranular control, use team-level permissions.The project administrator can use team areasto set location-based permissions.Team-level permissions include thesepermissions:Artifact operations• Create, delete, or modify artifacts bytype.• Modify artifacts by attribute.Folder operations• Create, delete, or modify folders.Link operations• Create, delete, or modify links by type.Team ownership operations• Modify team ownership.If you do not have permission to do certainactions in a project folder, you might not be amember of the team area that owns thatfolder.Organizing requirements information
  5. 5. 5© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.5 © Copyright IBM Corporation 2013Views: Get different perspectives of dataA view at the project level consists of columnlayout, column groups, and filters on tags,attributes, and folders.You can select whichcolumns to display.You can group data by criteria.You can applyfilters by tag,attribute, or folder.Views can be sharedor personal.A view at the project level consists of columnlayout, column groups, and filters on tags,attributes, and folders.A view provides a perspective of the set ofproject data.You can be created views as needed, oryou can save them for later use as shared orpersonal views.Saved views are key productivity aids. Youcan use saved views to get the right artifacts(rows) and attributes and links (columns) intoview.After you define filter criteria and selectcolumns to display, you can save a view.In the view section, click Save. In the NewView window, name the view, select whetherthe view is personal or shared, and then clickOK.In the view section, click Save. In the NewView window, name the view, select whetherthe view is personal or shared, and then clickOK.You can update saved views in one of twoways:•Open the view, edit it, and then click Save.•Click Update an existing view, select theview to update, and then click OK.Organizing requirements information
  6. 6. 6© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.6 © Copyright IBM Corporation 2013Collection artifactCollection artifactCollection artifactA collection is an artifact of type collection.A collection is a set of artifacts that you can group for aspecific purpose.Collections represent information in the form of aSpreadsheets.A collection is different from a view, because acollection is an artifact that contains a controlled set ofdata that is not dynamically updated based of filtercriteria.You might create a collection for these purposes:• Produce a quick, informal group of artifacts.• Identify a set of artifacts based on a common focus,such as requirements and related artifacts for aniteration, milestone, feature, function, teamownership, or other related purpose.• Capture a set of artifacts for reviews ,reports.• Create a glossary ( collection of term artifacts ).• Associate a set of requirements with a developmentplan or test plan.• Generate development work items and test cases,based on requirements in the collection.•Advantages:• Collections organize artifacts in lists.• You can display and edit artifact content, attributes,and links in columns.• You can sort artifacts by content, attributes, andlink information.• You can filter information by attributes and linkinformation.• An artifact can exist in one or more collection.• You can get different perspectives of the data in acollection by using views.• Collections can include other collections to providean ordered, logical structure of artifacts.• You can create artifacts while editing Create acollection by adding individual artifacts• You can baseline a collection and compare itsbaselines• Being an artifact, a collection has history that isaccessible for analysis .• You can create a review of the collection and itsartifacts.• You can export the collection contents to CSVformat.• You can generate a document-style report in PDF,Microsoft Word, HTML, or XSL-FO format.•Disadvantages• Collections lack peripheral and supportinginformation.• Collections lack informational hierarchy andstructure.Organizing requirements information
  7. 7. 7© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information7 © Copyright IBM Corporation 2013Text artifactsContent :Contains the main content of theartifact.Can include text, images, hyperlinks,and embedded artifacts.Text artifactAn artifact of format text is an artifact that uses the richtext editor.An artifact that is of format Text can be a piece ofinformation, a heading, a single requirement, or arequirements document.You can elaborate the content of such an artifact by usingrich-text. You can refer to other artifacts in the textartifact by using hyperlinks or by embedding artifacts inthe text artifact.In some projects, you can use a text artifact as arequirements document, in place of a module or acollection. In such projects, the text document links to orembeds requirements. Those requirements are managedat the project level in collections.•Advantages• You can quickly create a specification document byusing rich-text.• Text artifacts present information logically and incontext.• You can embed requirements in the artifact.• Hyperlink out to requirements or other information• New or existing artifacts can by hyperlinked orembedded in one or more text artifacts• You can create requirement artifacts while you edit.• Being an artifact, it has history that is accessible foranalysis.•Disadvantages• Sorting is not supported.• Filtering is not supported.• Views are not supported. You cannot change theperspective of data.• Embedded or linked artifact attributes cannot bedisplayed in columns and rows.• Artifacts cannot be edited in place. For example,you cannot edit links or attributes in place.• Text artifacts do not provide scope for theembedded artifact and this makes reuse difficult.When you edit an embedded artifact, all edits areapplied to the base artifact at the project level,including links, tags and comments.• Usually, rich-text artifacts require the support ofone or more collections.
  8. 8. 8© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information8 © Copyright IBM Corporation 2013Module artifactRequirements InformationGraphicsDiagramsModuleArtifacts are logicallyand hierarchicallyorganized.In the IBM Rational DOORS NextGeneration modules are the preferredway to capture your requirementsspecifications and work with artifacts.A module is a special type of artifact format thatprovides a logically and hierarchically structureddocument of artifacts that are individually structured.When a requirement is individually managed, you canlink directly to that requirement, track its history, andmore. A module looks like a spreadsheet; attributes andlink information are displayed in columns.A module is different than an artifact of the Text format,where contained requirements are not individuallymanaged and attributes cannot be revealed in columns.A module is also different than a collection. In acollection, you can group artifacts, but cannot organizethem logically and hierarchically.•Advantages:• A module looks like a document, but acts as aspreadsheet.• Modules present information logically and incontext.• Modules present information hierarchically. Youcan collapse, move, promote, demote, or removesections.• Artifacts in a module are individually managed.• Artifacts in a module can have hyperlinks or embedother artifacts.• You can create requirement artifacts while you edit.• You can sort artifacts in modules.• You can filter artifacts in modules.• You can apply views to get different perspectivesof data.• You can edit artifacts in place. For example, youcan edit an artifact’s links or attributes in context.• Modules support the reuse of artifacts. The baseartifact, which is artifact at the project level, isscoped within the module and has module-specifictags, comments, and links.•Disadvantages• The initial editing of a module requires the creationor addition of artifacts.• You must manage the hierarchy of artifacts in amodule.
  9. 9. 9© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.9 © Copyright IBM Corporation 2013Example of a moduleContent pane: logicallyand hierarchicallyorganized artifactsNavigation pane:filters and viewsLevel 1 sectionLevel 2 sectionThe module is organized very similarto the project level Artifacts page.However, instead of using folders, amodule uses sections to logically andhierarchically organize artifacts.Organizing requirements information
  10. 10. 10© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.10 © Copyright IBM Corporation 2013Module views: Changing perspectives of contentStakeholder System Sub-systemDropped?Scopecreep?Example: multi-level tracingWhen you create a view, you cansave it for all of the modules. Bysaving a view for all modules , youcan provide a consistent look whenyou analyze relationshipsVies are a productivity tool. Forexample, you can identify scopecreep or dropped requirements byusing a view that displays linkinformation in columns .Remember that tags, links, andcomments in a module are scoped tothe module.Organizing requirements information
  11. 11. 11© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.11 © Copyright IBM Corporation 2013Tags Tags are simple words orshort phrases that you attachto attributes. Tags are a powerful tool forcategorizing artifacts in aproject. With tags, you can filterartifacts and create specificviews. Personal tags are available toonly the person who createsthem. Shared tags are available toall users in a project.Tags provide an easy way tocategorize artifacts, and areespecially useful for informal ortemporary designations.Unlike an attribute, a tag is not part ofthat artifact type.Tags are an ad hock way to categoriesartifacts. A tag can be applied on anyartifactOrganizing requirements information
  12. 12. 12© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.12 © Copyright IBM Corporation 2013Creating tags12Click the Add New Tag icon.a. Name the tag.b. Click Shared orPersonal.c. Click OK.Organizing requirements information
  13. 13. 13© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.13 © Copyright IBM Corporation 2013Adding tags to an artifactOpen an artifact and click theSelect Tags icon.12Select the tags toapply, and then clickOK.Option tocreate newtag.To add a tag to an artifact, open theartifact and click the Select Tagsicon. A new window will appear.From that window, select the tags toapply. You have an option to create anew Tag, if the tags already providedare not sufficient. Click OK to applythe tags and exit the Select Tagswindow.Organizing requirements information
  14. 14. 14© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.14 © Copyright IBM Corporation 2013Adding tags to a group of artifactsApply filters to display theartifacts to tag. Select allartifacts, and from the menu,select Apply Tags to Artifacts.Organizing requirements information
  15. 15. 15© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.15 © Copyright IBM Corporation 2013Summary of benefitsFolder Collection Text ModuleLooks like a document  Acts like a spreadsheet   Supports views   Provides context to logically organizedartifacts Supports the controlled grouping ofinformation  Supports the reuse of artifacts   Provides scope for artifacts, such as links,tags, and commentsSupports the sorting of included artifacts   Supports the filtering of included artifacts   Supports the in-place editing of includedartifacts  This table summarizes the differentoptions for organizing requirementsand identifies a few of theiradvantages and disadvantages.Organizing requirements information
  16. 16. 16© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.16 © Copyright IBM Corporation 2013Lab 1: Working with FoldersAfter you finish this lab, you should be able to do thesetasks: Move artifacts to a folder Move a folder to a differentlocationOrganizing requirements information
  17. 17. 17© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.17 © Copyright IBM Corporation 2013Lab 2: Creating and applying tagsAfter you finish this lab, you should be able to do thesetasks: Create and apply a shared tag. Filter artifacts by tags.Organizing requirements information
  18. 18. 18© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information18 © Copyright IBM Corporation 2013Lab 3: Optional: Creating views at the module levelAfter you finish this lab, you should be able to do thesetasks: Use filters to focus on specific artifacts Create a view at the modulelevel
  19. 19. 19© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information19 © Copyright IBM Corporation 2013Review List a few ways in whichyou can organizerequirements. What is a base artifact? When you organizerequirements, what aresome advantages anddisadvantages to usingthese elements? Folders Collections Text artifacts Module
  20. 20. 20© Copyright IBM Corporation 2013Course materials may not be reproduced in whole or in part without the prior written permission of IBM.Organizing requirements information20 © Copyright IBM Corporation 2013Module summaryIn this module, you learned that many methods exist fororganizing information. Before you start a project, youmust weigh the advantages and disadvantages of eachmethod.

×