Design Specifications: Task-Oriented Site
Author: John Vaughan

This excerpt from a Design Specification document shows how I capture the essential elements of a highly transactional, task-oriented application site:

A descriptive Overview of functionality with a Workflow map. This is the context for all that follows.

Identification of Stakeholders/Actors and critical Use Cases (tasks). It's important to identify who's permissioned to do what.

Page Screenshot with description of the primary functions and their affiliated Business Rules. Here's the "meat" of the interaction.

 

1. Execution Overview

1.1 Overview

You can create or edit Executions and add Purchase Contracts and Sales Contracts to their affiliated Loadings. Every Execution consists of one or more Loadings. Every Loading consists of one or more Purchase Contracts and one or more Sales Contracts.

1.3 Stakeholders & Actors

The Execution Staff can view, create and edit Execution records and their affiliated Loadings. They can Settle Loadings. They cannot manage Overfills and Underfills.

Traders and Trade Admins can view Executions and Loadings. They cannot Settle Loadings. They can manage Overfills and Underfills.

Accountants can view Executions and Loadings. They cannot Settle Loadings. They cannot manage Overfills and Underfills.

Task Function Use Case Permission
Search & Select Search & select Executions and Loadings UC14 Execution Staff, Trader, Trade Admin, Accountant
Create Execution Create new record UC11 Execution Staff
Edit Execution Edit existing record UC12 Execution Staff
Create Loading Add Purchase Contracts, Add Sales Contracts UC15 Execution Staff
Edit Loading Add Purchase Contracts, Add Sales Contracts UC16 Execution Staff
View Execution / Loading Print Loading, Settle Loading UC13, UC17 Execution Staff, Trader, Trade Admin, Accountant
Manage Overfill Contract overfilled UC19 Trader, Trade Admin
Manage Underfill Contract underfilled UC20 Trader, Trade Admin

 

2. Execution section (edit / create)

Execution Staff can create and edit (Traders, Trade Admins and Accountants have View-Only permission).

2.1 Select Executions and Loadings (UC14)

Clickable items in the Search Results table go to either Edit or View pages, depending on your permissioning.

Item Type Description Bizrule
Search Results Table table Populated by system:
Execution ID, Vessel Name, Loading ID, Loading Type, Status, Profit Center, Commodity Group, B/L Date, Loaded Quantity, UOM
BR155
Execution ID link Go to Edit Execution page. BR127
Loading ID link Go to Edit Loading page. BR128
Add+ link Go to Add Loading page. BR148
Settle link Begin Settlement process. BR160
Create New Execution button Go to Create Execution page BR156

Cross-Reference to Business Rules