Your SlideShare is downloading. ×
Working With Auc Documents
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×
Saving this for later? Get the SlideShare app to save on your phone or tablet. Read anywhere, anytime – even offline.
Text the download link to your phone
Standard text messaging rates apply

Working With Auc Documents

588

Published on

This slideshow describes a method for working with use cases inside ReqPro. It contains a use case template that filled in over a project lifecycle. Once it is complete the use case is moved to a …

This slideshow describes a method for working with use cases inside ReqPro. It contains a use case template that filled in over a project lifecycle. Once it is complete the use case is moved to a repository and merged with the existing use cases for the application.

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

No Downloads
Views
Total Views
588
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
0
Comments
0
Likes
1
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

  • 1. Working With An AUC Document Requirements Discipline June 7, 2009
  • 2. Precursor
    • In order to understand the material in this course, you should have knowledge of the material in the following courses:
      • Working With Styles and Properties.
      • An introduction to RequisitePro.
    06/07/09
  • 3. Overview
    • In this presentation you will learn:
      • the purpose of the different sections of the AUC document,
      • the information that goes into each section,
      • when to use an AUC document template,
      • working with AUCs and RequisitePro,
      • how to deploy an AUC.
    • This lesson will end with a Q & A session.
    06/07/09
  • 4. The sections of the AUC Document
    • The AUC document captures a single application use case for a single application.
    • It’s sections are:
      • 1 Introduction
      • 2 Use Case Details
      • 3 Use Case Supplementary Requirements
    • The template that comes with this presentation is designed to be imported into RequisitePro.
    • The guidelines in this presentation can be adjusted for whatever requirements management tool you use.
    06/07/09
  • 5. Introduction
    • This section contains introductory text for the AUC:
      • Purpose – The purpose of the AUC document (this is standard text where only the name of the document changes),
      • Audience – Who this document is written for (may change from project to project),
      • Scope – What is in this document,
      • Definitions, Acronyms, and Abbreviations – Any terms specific to this AUC,
      • Overview – A high level description of what this use case is trying to achieve.
    06/07/09
  • 6. Use Case Detail
    • This section contains the use case details:
      • Description – an overview of the details of the use case,
      • Usage – the maximum frequency that the use case is expected to execute,
      • Primary Actor - the initiator of the use case,
      • Secondary Actors - any roles or systems used by the use case,
      • Precondition - what state the application must be in before the use case executes,
      • PostCondition - the state the system is expected to be in after the use case has ended successfully ,
      • Alternative Postconditions – other possible states that could end the use case,
      • Main Flow - the externally visible steps of the use case that cause the expected postcondition ,
      • Alternate Flows - externally visible steps that deviate from and return to the basic flow,
      • Extension Points - externally visible steps that describe a path that extends from the basic flow and terminate at an alternative postcondition,
      • Interaction Diagram - a pictorial view of the use case.
    06/07/09
  • 7. Supplementary Requirements
    • A temporary location for requirements that impact this use case, used to maintain traceability between the use case steps and the supplementary requirements when the AUC document is not in ReqPro.
      • Supplementary requirements may be of type: Usability, Reliability, Performance, Supportability, Design Constraint, Accessibility, Globalization, Availability, Installability, Serviceability (Maintainability), Security, (Vulnerability), User Documentation, Consumeability (Migration), Integration, Software Reuse/Componentization, Purchased Components, Interfaces, Licensing Requirements, Legal/Copyright/Other Notices, Applicable Standards, To be determined .
    06/07/09
  • 8. A Use Case Is Black Box
    • An ‘externally visible step’ is an action that can be observed from a ‘black box’ perspective.
    • A black box observation is an event that can be detected without opening up the application.
    • All black box events are witnessed by the actors of the application.
    • All black box events are tested at the interfaces to the application.
    • Example: ‘The system verifies that the password is correct’ is NOT a black box event, because we cannot test this when the password is correct, without opening the application.
    • Example: ‘The password is invalid and the system returns a password in error message’, is a black box event because we entered an invalid password through the user interface and got the error message back through the user interface.
    • When writing a step, ask yourself the question: ‘How would I test this?’
    06/07/09
  • 9. Creating the Use Case Document
    • Add the AUC document template to the templates that are recognized by MS Word.
    • Create a new AUC document in MS Word.
    • Complete the properties for the AUC document.
    • Complete the introductory sections.
    • Once the scope and overview have been agreed upon, start to detail the steps of the basic flow.
    • Once the basic flow has been agreed upon, search for alternative and extension paths.
    06/07/09
  • 10. Example Introductory Section 06/07/09
  • 11. Create The Use Case
    • Complete section 2.
    • Add a use case diagram, showing the actors.
    • Set the style of the text in the description field to be ‘Use Case’.
    • The description will become the parent use case.
    06/07/09
  • 12. Numbering The Steps
    • Apply the 'Use Case Step‘ style to each line of the use case flow.
    • This will cause the steps to be automatically numbered and become blue-underlined, as they appear when selected as requirements in ReqPro.
    06/07/09
  • 13. Alternate And Extension Flows
    • Once the Basic Flow is complete we start to look for alternate and extension flows.
    • Entering Steps For Alternate And Extension Flows:
      • Enter alternate flow heading s and apply the 'Alternate Flow‘ style to them .
      • Enter extension flow heading s and apply the Extension Flow‘ style to them .
      • Enter each alternate and extension flow step and apply the ‘Use Case Step ‘ style.
      • For each alternate /extension flow make reference to the step (s) that it comes from in the use case Basic Flow , by us ing the 'Insert->Reference->Cross Reference' command to reference the step number.
      • Similarly when an alternate flow returns to the basic flow, use Word’s ‘Cross-Reference’ feature to enter the step that is returned to.
    06/07/09
  • 14. Enter Alternate/Extension Flow Steps
    • Alternate and extension flows without references to the basic flow.
    06/07/09
  • 15. References Within Use Case Steps
    • Using the Word command, ‘Insert->Reference->Cross Reference’, select the Numbered Item’ Reference Type, Insert Reference To ‘Paragraph Number’ an make sure that ‘Insert As HyperLink’ is ticked.
    • Once all references to use case steps have been inserted, you may navigate between flow references using the ‘Control/Click’ function of Word.
    06/07/09
  • 16. Renumbering the steps
    • Suppose (as it will happen) that a new step is inserted or an existing step is taken out of scope.
    • Simply add or remove the step(s), select all text and press F9.
    • All steps and cross-references are automatically updated with the correct numbers.
    • (two new lines have been inserted.)
    06/07/09
  • 17. The Updated Cross-References 06/07/09
  • 18. Demo
    • Create a use case document from the AUC template.
    • Select the correct styles for each section of the document.
    • Adding cross-references to the use case steps.
    • Renumber steps in the use case by adding and removing steps in the basic flow and the alternate flows.
    • Ctrl-A + F9 to update fields.
    06/07/09
  • 19. Use Case Supplementary Requirements
    • This section contains supplementary requirements that impact this use case.
    • These requirements are captured here temporarily and ultimately reside in the supplementary requirements folder of ReqPro.
    • All identified supplementary requirements (including business rules) are captured here during the development of the use case.
    • All supplementary requirements are traced to the use case step(s) to which they apply; note that capturing and identifying the supplementary requirements in the use case document as it's being developed helps to ensure that they are traced to the use case steps.
    06/07/09
  • 20. Capturing Supplementary Requirements
    • As you detail a step of the use case recognize impacting supplementary requirements.
    • Document these in the AUC document, under Supplementary Requirements, and reference the steps that they impact, using cross-references.
    • Set the style for each supplementary requirement to be ‘Supplementary Requirement’.
    • When the AUC is imported to the RequisitePro, identify if the supplementary requirement is already captured elsewhere (search the Supplementary Requirements attribute matrix view, for the requirement)?
    • If it is there, make sure it is traced to the use case step and delete the imported supplementary requirement.
    • If the supplementary requirement does not exist, move it from the AUC document to the supplementary requirements folder and trace it to the step.
    • Why move the supplementary requirements, once they are in ReqPro?
      • Because we want to avoid duplication of requirements and ReqPro does not allow the same requirement to be located in 2 places.
    06/07/09
  • 21. Example Supplementary Reqmts
    • Each supplementary requirement is tagged with ‘[Step #]’ where # is a cross-reference to the impacted step in the AUC.
  • 22. Importing An AUC Document
    • The reason for the ‘use case’, ‘use case step’ and ‘supplementary requirement’ styles are that they allow us to automatically create requirements in ReqPro.
    • When the AUC Document is imported, (see also Working With Requirements In ReqPro), we tell ReqPro to make every line of style ‘use case’, ‘use case step’ or ‘supplementary requirement’ into a requirement.
    06/07/09
  • 23. Importing AUC Document
    • Import existing AUC documents into the ReqPro project by selecting the folder to contain the document and entering the ‘File->Import’ command.
    06/07/09
  • 24. Import An AUC Document
    • Browse to select the existing document from your desktop.
    • Select the ‘Microsoft Word Document’ option
    06/07/09
  • 25. Import Document And Requirements
    • We import the document because we will be working on the AUC from within ReqPro from now on.
    • The desktop version of the document is obsolete.
    06/07/09
  • 26. Document Properties
    • Enter the document properties:
      • document name,
      • A description of the contents of the document,
      • the folder where it will reside,
      • Where the document can be found on your desktop,
      • The document type.
    06/07/09 Press ok, and when prompted to retain the document formatting, select ‘Yes’.
  • 27. The ReqPro Import Wizard
    • Note that the ‘use case’, ‘use case step’ and supplementary requirement’ styles have been added to the list of styles that signify a requirement.
    • Both the use case and use case step styles have been assigned to use case requirement types.
    06/07/09
  • 28. Confirming The Import
    • When prompted to make a requirement, select ‘Yes To All’.
    • When prompted to commit the requirements, verify that they are correct and select ‘Commit’.
    06/07/09
  • 29. Organize The Requirements
    • The document and requirements are imported to the selected folder.
    • The AUC steps are made children of the parent AUC by selecting the steps and executing a ‘Change Parent’ command.
    06/07/09
  • 30. Move Supplementary Requirements
    • Once Imported the supplementary requirements are moved from the AUC document to the Supplementary Requirements folder.
    • Open the AUC Document in ReqPro.
    • Locate the supplementary requirement.
    • Execute a ‘RequisitePro->Requirement->Cut’ command, and the requirement is removed from the document.
    • Open a supplementary requirements view and execute ‘Edit->Paste’ to move the requirement to the view.
    • Determine if this is a duplicate requirement and if so delete it.
    • Trace the supplementary requirement (or its duplicate if deleted) to the AUC step(s) that it impacts.
    06/07/09
  • 31. Cut A Requirement 06/07/09
  • 32. Paste Supplementary Requirements
    • The requirements are pasted into the supplementary requirements view.
    • The requirements are moved from the ‘Application Use Case’ folder to the ‘Supplementary Requirements’ folder.
    06/07/09
  • 33. Trace Supplementary Requirements
    • The supplementary requirement traces To the use case step that it impacts.
    06/07/09
  • 34. Demo
    • Import an AUC document.
    • Set the use case steps to be children of the parent AUC.
    • Move the supplementary requirements to the supplementary folder in the requirements explorer.
    • Trace the supplementary requirements to the use case steps they impact.
    • Set the status of the AUCs to ‘Detailed’.
    06/07/09
  • 35. Generating The AUC Document
    • When you need to review the AUC document, many of the reviewers will not have access to ReqPro (many of your reviewers will refuse to use ReqPro even if you do give them access.
    • You will need to take the document offline (prevents it from being edited while being reviewed).
    • You will need to add the supplementary requirements to the off line document.
  • 36. Review The AUC Document
    • Take the document offline, using ReqPro’s ‘Offline’ command.
    • Run the attached SoDA template and enter the document’s location when prompted.
    • An AUC document including supplementary requirements is generated.
  • 37. Once The Review Is Complete
    • ‘ Cancel’ the offline document, deleting the version on your desktop.
    • All changes to the AUC document are made through the ReqPro UI.
    • Once the changes are complete, you might want to set the status of the AUC and all supplementary requirements, to ‘Approved’.
  • 38. Demo
    • Take an AUC document offline.
    • Run the SoDA script to generate an AUC document for review.
    • Cancel the offline document.
    • Set the requirements status to approved.
  • 39. Completing The Use Case Overview
    • This process assumes an iterative approach to deployment.
    • It assumes that several use cases may be deployed at each iteration.
    • The supplementary requirements that impact the AUC are copied into the Supplementary Requirements section of the AUC document.
    • The AUC documents are taken offline and merged with the existing AUCs in MS Word.
    • The merged AUCs are imported to the application database in an AUC document.
  • 40. Completing The AUC Document
    • Once the AUC is deployed into production, the application’s central repository needs to be updated to reflect what is in production.
    • Set the status of every deployed requirement to ‘Deployed’, (We do not set the status of the AUC step, since they take the status of their parent).
    • Using ReqPro’s ‘Copy’ and ‘Paste’ commands, place copies of the supplementary requirements that impact the AUC into the Supplementary Requirements section of the AUC document.
    • The AUC document is then taken offline.
    06/07/09
  • 41. Supplementary Requirements
    • Don’t forget to add cross-references to the steps that the supplementary requirement impacts.
  • 42. Take The AUC Document Offline
    • Taking a document offline means that it can no longer be edited through the ReqPro user interface.
    • Select the AUC Document and execute the ‘Offline’ command.
    • You will be prompted for a location for the document on your desktop.
    • Enter a reason for taking the document offline.
  • 43. Existing AUC Document
    • Take The Existing AUC Document Offline from within the application Reqpro data base, if it already exists. (If the AUC does not already exist, no merging is required.)
  • 44. Cleaning Up
    • Merge the AUC Documents using MS Word’s ‘Compare And Merge’ function.
    • Save the resulting file over top of the AUC document taken offline from the application central repository.
    • Bring the AUC Document back online.
    • Clean up the requirements.
    • Move the supplementary requirements to ReqPro explorer’s ‘Supplementary Requirements’ folder, overwriting any that already exist.
    • Ensure that the supplementary requirements trace to the steps that they impact.
    • Cancel all offline documents from the project ReqPro repository, deleting those documents taken offline.
  • 45. Merging AUC Documents
    • Different versions of MS Word have different merge dialogue boxes. This is the 2007 version.
  • 46. Example Merge
    • Use MS Word’s reviewing buttons to accept (or reject) the changes.
    • Save the resulting document over the application ReqPro document on your desktop.
  • 47. Cleaning Up
    • In the application ReqPro repository, bring the AUC document back online. This will overwrite the existing AUC document with the new version.
    • In the project ReqPro repository, cancel the offline document, deleting the version on your desktop.
  • 48. Move The Supplementary Reqmts
    • If the supplementary requirements do not already exist, cut them from the document and paste them into the database through a view.
    • Update the traceability to point to the impacted use case steps.
  • 49. Replace The Supplementary Reqmts
    • If the Supplementary requirement already exists, copy its existing traceability references to the updated requirement.
    • Move the updated requirement to the Supplementary Requirements folder.
    • Delete the existing requirement by setting its status to ‘Deleted’ and moving it to the ‘Deleted Requirements’ folder.
  • 50. Demo
    • Set the status of deployed requirements to ‘Deployed’.
    • Move the supplementary requirements to the AUC document.
    • Take the project AUC document offline.
    • Take the application AUC document offline.
    • Merge the 2 documents.
    • Import the AUC document into the application ReqPro repository.
    • Move the supplementary requirements from the AUC document.
    • Bring the application AUC document online.
    • Cancel the project AUC document offline.
  • 51. AUC Document Relationships
    • A single AUC is documented in an AUC document.
    • An AUC contains AUC steps.
    • AUC steps are requirements in a ReqPro database.
    • Supplementary requirements trace from AUC steps.
    • Supplementary requirements are contained in either the ReqPro database or in an AUC document.
    06/07/09
  • 52. Summary
    • In this presentation you learned:
      • the purpose of the different sections of the AUC document.
      • the information that goes into each section.
      • when to use the AUC document.
      • how to detail an AUC document.
      • how to import an AUC document into ReqPro.
      • how to export an AUC document from ReqPro.
      • how to merge a projects AUC document into the AUC document for an application.
    06/07/09
  • 53. References
    • The Application Use Case Document template in MS Word is located here .
    • The Working With Styles and Properties presentation is here.
    • The Introduction To ReqPro presentation is here . (or here -> http://www.linkedin.com/osview/canvas?_ch_page_id=1&_ch_panel_id=1&_ch_app_id=10517260&_applicationId=1200&_ownerId=4416077&osUrlHash=FUXL&appParams=%7B%22view%22%3A%22canvas%22%2C%22page%22%3A%22show_slideshow%22%2C%22slideshow_id%22%3A%22792658%22%2C%22from%22%3A%22share_slideshow_url%22%7D
  • 54. Test Your Knowledge
    • How many use cases are there in an application use case document?
    • What do we call a constraint on the state of the application before the use case may execute?
    • If an actor is entering data into the application and has to stop (end the use case) because there is missing information, is this documented under an alternative or extension flow?
    • Open the AUC document style guide and change the example AUC in the document into a true use case with the correct styles and references applied.
    • Import the AUC document to ReqPro, keeping the original AUC document on your desktop.
    • Change the AUC document inside ReqPro.
    • Take the AUC document offline.
    • Merge the AUC document with the original AUC document.
    • Bring the AUC document back online in ReqPro.
    06/07/09

×