Use Case & Documentation Samples
This page shows samples of technical documentation using Visio, Word, and Axure. (This page is in process some items are still missing.)
Visio - Use Case Diagram for Lookup Customer
| usecasediagramlookupcust.pdf |
I am creating process flows for a fictitious construction home improvement company, named Guardian Home Services. The company needs a software program that allows them to look up a customer and then access other processes including view customer summary, manage customer information, create a quote, view an existing quote, view active job information, and view closed jobs This diagram shows the relationship between the use cases.
View a larger graphic.
View a larger graphic.
|
Visio - Process Flow Chart Sample
I am creating process flows for a fictitious software named Quick Quote for a home improvement construction company, named Guardian Home Services. While designing software the development team interviews the stakeholders, and Subject Matter Experts (SME) for information defining the processes needed for accomplishing tasks the company wants to be accomplished. This use case takes the user through the processes of looking for a customer account in the system.
View larger Graphic.
View larger Graphic.
| lookupcustflowchartlinkedin3.pdf |
|
Word - Use Case Specification Document
.QUICK- QUOTE
Use Case Specification: Lookup Customer
Version 13.4
1. Use Case Name: UC10 Lookup Customer.
1.1 Brief Description.
UC10.1 This use case details the steps involved in searching for customer records in the system. It includes the scenarios for search results matching the exact customer, zero records, or finding 2 or more records. The use case begins when the customer service representative (CSR) selects the Customer Lookup option. The use case ends when the system successfully displays the CSR’s search criteria.
NOTE: The wire frames in this document have been updated based on SME design sessions. Refer to the document “UI Prototype11302006.doc” for the latest UI/wire frames.
2. Assumptions.
N/A
3. Use Case Diagram.
5.1 Primary Actor.
6.1 UC10.4 Login.
User has logged into the system.
6.2 Network.
Network is up and active.
7. Triggers.
User selects “Lookup Customer.”
8.1Basic Flow –One or more records found.
6. System determines if Use Case or product type was selected.
[A-3: Product Not Identified].
[A-4: Manage Customer].
[A-5: Product Type-Create_New_Quote].
[A-6: Product Type-View_Existing_Quote].
[A-7: Product Type-View_Active_Job].
[A-8: Product Type-View_Closed_Job].
7. System invokes UC View Customer Summary.
8.1.1A-1 Two or More Matching Records (Duplicates).
[A-10: Ignore] – System evokes UC View Customer.
3. Use Case Ends.
8.1.2A-2 Zero Matching Records.
[A-12: Add Customer] – System evokes UC Manage Customer.
4. System retains original search criteria in respective fields.
5. Go to Step-2 of Basic Flow.
8.1.3A-3 Product Not Identified.
9.1UC10.8 Success.
Customer record exists in the system.
9.2Failure.
Customer record does not exist in the system.
Use Case Specification: Lookup Customer
Version 13.4
1. Use Case Name: UC10 Lookup Customer.
1.1 Brief Description.
UC10.1 This use case details the steps involved in searching for customer records in the system. It includes the scenarios for search results matching the exact customer, zero records, or finding 2 or more records. The use case begins when the customer service representative (CSR) selects the Customer Lookup option. The use case ends when the system successfully displays the CSR’s search criteria.
NOTE: The wire frames in this document have been updated based on SME design sessions. Refer to the document “UI Prototype11302006.doc” for the latest UI/wire frames.
2. Assumptions.
N/A
3. Use Case Diagram.
- See above graphic.
- See Above graphic.
5.1 Primary Actor.
- CSR
- None
6.1 UC10.4 Login.
User has logged into the system.
6.2 Network.
Network is up and active.
7. Triggers.
User selects “Lookup Customer.”
- Use Case “Manage Customer.”
- Use Case “Create New Quote.”
- Use Case “View Existing Quote.”
- Use Case “View Active Jobs.”
- User selects “View Closed Jobs.”
8.1Basic Flow –One or more records found.
- System displays the Customer Search screen as per wire frame UC10-WF-001Lookup Customer_CustSearch.
- User enters search criteria and selects Search.
- System performs search based on search criteria. [A-1: Two or More Matching Records] [A-2: Zero Matching Records].
- System displays UC10-WF-002Lookup Customer_CustSearchResult. Results displayed are as follows.
- Customer Last Name.
- Customer First Name.
- Email Address.
- Customer’s Phone Number (Primary Phone Number).
- Customer’s Cell Phone Number.
6. System determines if Use Case or product type was selected.
[A-3: Product Not Identified].
[A-4: Manage Customer].
[A-5: Product Type-Create_New_Quote].
[A-6: Product Type-View_Existing_Quote].
[A-7: Product Type-View_Active_Job].
[A-8: Product Type-View_Closed_Job].
7. System invokes UC View Customer Summary.
8.1.1A-1 Two or More Matching Records (Duplicates).
- Alternate flow begins at Step-3 of Basic Flow.
- System finds duplicate records and displays message UC10-WM-002DupCust, user may choose Merge. Customer or Ignore.
[A-10: Ignore] – System evokes UC View Customer.
3. Use Case Ends.
8.1.2A-2 Zero Matching Records.
- Alternate flow begins at Step-3 of basic flow.
- System finds no results (i.e. Zero records) based on search criteria.
- System displays message UC10-WM-001ZeroCust, user may choose Search Again or Add Customer.
[A-12: Add Customer] – System evokes UC Manage Customer.
4. System retains original search criteria in respective fields.
5. Go to Step-2 of Basic Flow.
8.1.3A-3 Product Not Identified.
- Alternate Flow begins at Step 5 of Basic Flow.
- System invokes UC View Customer.
- Use Case Ends.
- Alternate Flow begins at Step 5 of Basic Flow.
- System invokes UC Manage Customer.
- Use Case Ends.
- Alternate Flow begins at Step 5 of Basic Flow.
- System invokes UC Create Quote.
- Use Case Ends.
- Alternate Flow begins at Step 5 of Basic Flow.
- System invokes UC View Existing Quote.
- Use Case Ends.
- Alternate flow begins at step 5 of basic flow.
- System invokes UC View Active Job.
- Use Case Ends.
- Alternate Flow begins at Step 5 of Basic Flow.
- System invokes UC View Closed Jobs.
- Use Case Ends.
9.1UC10.8 Success.
Customer record exists in the system.
9.2Failure.
Customer record does not exist in the system.
User Guide Sample - for Lookup Customer
About This Sample Guide (In Process of Updating this Document.)
This is a sample user guide for a factious banking system. The UI is a place saver. The original screen shot would inserts here.
Due to the nature of building software, the user guide requires updates along with the system updates. The first page has a revision history table listing the changes made to the chapter. This revision history keeps track of change requests that impact the user guide.
Steps in the user guide are created from analyzing the business analyst’s use case, process flow, and artifact table listing the UI components. As the system is created, the user guide is updated with captured screen graphics.
In my job with Cash Americas, the draft user guide was reviewed by the subject matter experts (SME) because they had a hard time understanding the use cases and other documents. A document like this one allowed them to step through their process flow in a way they understood.
This is a sample user guide for a factious banking system. The UI is a place saver. The original screen shot would inserts here.
Due to the nature of building software, the user guide requires updates along with the system updates. The first page has a revision history table listing the changes made to the chapter. This revision history keeps track of change requests that impact the user guide.
Steps in the user guide are created from analyzing the business analyst’s use case, process flow, and artifact table listing the UI components. As the system is created, the user guide is updated with captured screen graphics.
In my job with Cash Americas, the draft user guide was reviewed by the subject matter experts (SME) because they had a hard time understanding the use cases and other documents. A document like this one allowed them to step through their process flow in a way they understood.
Use Case Artifact Sample (In Process of Updating this Document.)
This is an Artifact Excel Sheet. It lists the UI elements and buttons on the computer screen and the actions that occur when selected. The Artifact, assigns UI elements a number so while in meetings team members refer to the number creating less confusion. Additionally, the actions, shortcut key, and focus numbers are listed in the Artifact.
©2020 Janet Alexander Designs. All rights reserved. This site and all jewelry designs, artwork, and information are protected under copyright law. Reproduction in whole or part are prohibited.
