Capturing requirements: Importing documents

Transcription

1 Contents Module overview -2 Importing requirements into a project -3 Importing process checklist -4 Importing a document and creating a module -5 Import results -10 Creating a module? Word paragraph styles matter -11 Checking styles -12 Lab 1: Importing a Microsoft Word file as a RM module -13 Lab 2 : Importing requirements artifacts from a CSV file -14 Review -15 Module summary -16 Capturing requirements: Importing documents Capturing requiremetns : importing a document 1

2 Module overview After you complete this module, you should be able to do these tasks: Import a word document and create a module with supporting artifacts Import a CSV file and create requirements artifacts 2 Capturing requiremetns : importing a document 2

3 Importing requirements into a project Import from various sources: Publication tools Tables, such as database exports Text files Scanned documents Automatically extract and create rich-text artifacts, and optionally a module, from a document file. Create rich-text artifacts from a CSV file. Exchange requirements by using a ReqIF file. Create a rich-text artifact from a document file. 3 You can import requirements from documents and CSV files into a requirements project. You might have project requirements that are documented in a spreadsheet or in a Microsoft Word document. You might find it easier to solicit early stakeholder input in a document outside of the requirements management application. If necessary, you can import documents of various types into your requirements management application project and make the content available to other users. You can import information in these ways: Import and extract requirements from a text document. Import requirements from a CSV file. Import a text document and covert it to a rich-text file. Tips: Use the CSV import function to import simple textual requirements that have associated attribute values. Use the Word import function to import rich-text documents, including documents that have embedded images or other embedded objects. Import requirements from within a text document when you want to automatically create a set of requirements artifacts from a text document. Capturing requiremetns : importing a document 3

4 Import checklist Preparing the source file or files for import implies tagging the file with delimited text, making sure the correct styles are used, and more Identify the essential data sources and files. Select the import location. Determine how you want the information to be imported. Rich-text artifact Artifacts Diagrams Graphics Information Requirements Headings Module artifact Analyze the source data format. Prepare source file or files for import. Test the import: if necessary, modify the source file. Run the import. Verify and save the results. 4 Capturing requiremetns : importing a document 4

5 Importing a document and creating a module (step 1/4) To start the import wizard, select Artifacts > Import. Determine how you want the information to be imported. 5 Capturing requiremetns : importing a document 5

6 Importing a document and creating a module (step 2/4) In the import wizard, you define how the requirement artifacts are extracted. You can specify where to save the artifacts that are created from the import. Define the criteria to use to identify the requirements. The artifact types that are created depend on the criteria that you specify. Identify the essential data sources and files. Select the import location. Determine how you want the information to be imported. 6 Capturing requiremetns : importing a document 6

7 Importing a document and creating a module (step 3a/4) The RM application identifies requirements in a text document by detecting headings, images, keywords, and text delimiters in the document. For each part of the document, you can specify an artifact type to create. Define the criteria to use to identify the requirements. The artifact types that are created depend on the criteria that you specify. Use the style in the document to specify a certain artifact type. Specify how to handle image files. Identify keywords and assign an artifact type to each. 7 Capturing requiremetns : importing a document 7

8 Importing a document and creating a module (step 3b/4) Identify text delimiters and assign an artifact type to each. Specify an artifact type to apply to all other text. 8 Capturing requiremetns : importing a document 8

9 Importing a document and creating a module (step 4/4) Before you extract and import the requirements, review the artifacts. If you see unexpected results, make changes. 9 Capturing requiremetns : importing a document 9

10 Import results After the import is complete, verify that all of the requirements were correctly extracted. You might need to clean up the new requirements. Module Folder with artifacts that compose the module 10 Capturing requiremetns : importing a document 10

11 Creating a module? Paragraph styles matter Paragraph styles in Microsoft Word correspond to the structural hierarchy of a module in the RM application. When you import a Microsoft Word document into the RM application, the artifact hierarchy is created based on the applied styles in Microsoft Word. Level 1 Section artifact (Heading) Level 2 artifact Level 2 Section artifact (Heading) Level 3 artifact 11 Capturing requiremetns : importing a document 11

12 Checking styles Before you import a Microsoft Word document into the RM application, check the paragraph styles that are applied in Microsoft Word. Make sure that the styles are applied correctly. Paragraphs in the Microsoft Word document that have outline levels 1-9 are imported as Artifact and create Sections 12 Capturing requiremetns : importing a document 12

13 Lab 1 : Importing a Microsoft Word file as a RM module At the end of this lab, you should be able to do these tasks : Describe how Microsoft Word paragraph styles affect a module that is created by an import. Prepare for an import by identifying and fixing paragraph style problems. Import a Microsoft Word file to create a module and its supporting artifacts. 13 Capturing requiremetns : importing a document 13

14 Lab 2 : Importing requirements artifacts from a CSV file At the end of this lab you will be able to: Describe how Microsoft Word paragraph styles affect a module that is created by an import Prepare for an import by identifying and fixing paragraph style problems in Microsoft Word Import a Microsoft Word file to create a module and its supporting artifacts. 14 Capturing requiremetns : importing a document 14

15 Review List a few options for importing requirements from external files. Before you import a Microsoft Word document, what information must you consider? 15 Capturing requiremetns : importing a document 15

16 Module summary In this module, you learned how to do these tasks : Import requirements from a CSV file Import a Microsoft Word document and create a module and its artifacts 16 Capturing requiremetns : importing a document 16