Sample technical document
NOTE: THIS IS FOR JOB APPLICATION PURPOSES ONLY. THIS IS NOT THE ORIGINAL DOCUMENT. SOME CONTENTS
WERE REMOVED AND SOME WORDS WERE REPLACED BY DESCRIPTION TO PROTECT CONFIDENTIAL INFORMATION
FROM MY PREVIOUS EMPLOYER.
PROJECT
Revision No.
--Project Name--
Details/SR Code
Reference/AI Number
Responsible
SCOPE
Date Modified
Date Released
LIMITATION
ACRONYM/TERMINOLOGY
PROCESS FLOW CHART
Sign off document
Page 1 of 18
SYSTEM REQUIREMENTS (SR) LIST
FILE REFERENCES
Note:
SR Code
JOB INFORMATION PANE & JOB MANAGER:
SR-UI-JM-01
SR-UI-JM-02
SR-UI-JM-03
TOOL BAR
SR-UI-TB-01
SR-UI-TB-02
USER INTERFACE REQUIREMENTS
SR Description
CHANGE REQUEST FORMS (CRF)
CRF Ticket
Description
CR-TK-13215
CR-UI-13116
USER INTERFACE REQUIREMENTS
MODULE
--Module Title---Change Description--
SR-UI-JM-01
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint: Web Connector:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name/ Control
Reference Dropdown
Action
13th
On Select of
Edition:
- End Plate Connections (Skewed) will not be supported
- Display in Sketch Pane, “Connection not supported.”
On Select of 14th Edition or 15th Edition:
- Display in Sketch Pane, “Connection not supported.”
Structural Integrity
Requirement Dropdown
On Select of any Structural Integrity Requirement:
- End Plate Connections (Skewed) will not be supported
- Display in Sketch Pane, “Connection not supported.”
--Change Description--
SR-UI-SP-13
Front
Side
Screen
Layout
Sign off document
Page 2 of 18
Top
Applicability
FUNCTIONAL SPECIFICATIONS
Data Condition and Validation
If active Doubler Plate in the connection is only one:
Under Connection Tab
Display Doubler Plate on the other side of beam web (FS side).
Display Doubler Plate as broken lines in the front view
--Change Description--
SR-UI-PRI-05
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Input Fields
Field Name/ Control
Load Criteria Dropdown List
Story Height Textbox
Action Fields
Field Name
Load Criteria Dropdown
list
State
Description
Format
Specific
Applicability
Enabled
Field Description: Load Criteria
NA
NA
Initially Hidden;
Enable when
displayed
Field description: Story Height
#’-#”
NA
Data Type/Length/Values
Values:
- Given Load (Default)
- Design Load
Max Character: 15 chars
Default: 0’-0”
Action
Data Condition and Validation
• On Select of Given Load:
For W Column Primary
-
Strory Shear at Strong Axis Textbox and Story Shear at Weak Axis
Textbox will show.
Story Height Textbox will be hidden.
For HSS Wall Primary:
- Strory Shear Along Beam 1/Beam 2/Beam 3/Beam 4 Textbox will
show.
- Story Height Textbox will be hidden.
-
• On Select of Design Load:
For W Column Primary
-
Strory Shear at Strong Axis Textbox and Story Shear at Weak Axis
Textbox will be hidden.
Story Height Textbox will show.
For HSS Wall Primary:
- Strory Shear Along Beam 1/Beam 2/Beam 3/Beam 4 Textbox will
be hidden.
- Story Height Textbox will show.
Sign off document
Page 3 of 18
--Change Description--
SR-UI-SEC-02
Beam 1 / 2 / 3 / 4
Flange Plate (Bolted)
Directly Welded
Note: Refer to existing functionality of field properties.
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name
Cantilever Checkbox
Action
Data Condition and Validation
On tick:
- Cantilever checkbox in
opposing beam should be
disabled.
--Change Description--
SR-UI-SEC-03
Beam 1 / 2
Screen
Layout
Note: Refer to existing functionality of field properties.
Applicability
Sign off document
Reference:
Connection No.:
Connection Type:
Page 4 of 18
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Input Fields
Field Name/ Control
Beam Cut Dropdown List
Data Type/Length/Values
State
Description
Format
Specific
Applicability
---no change---
---no change---
NA
NA
Values:
Beam to Column Flange
- Case 1
- Case 2
- Case 3 (Default)
- Case 4
Beam to Girder
- Case 1
- Case 2
- Case 3
- Case 4
Action Fields
Field Name
Action
Beam Cut Dropdown List
Data Condition and Validation
Beam to Column Flange
On select of Case 1 or Case 2:
- Display “Connection not supported” in Sketch Pane.
Beam To Girder
On Select of Case 1 and Case 2:
- If Beam has no Top and Bottom Cope (Length and
Depth), Display “Connection not supported” in Sketch
Pane. Case 1 and Case 2 are only applicable if Beam has
Top and Bottom Cope.
--Change Description--
SR-UI-SEC-04
Beam 1 / 2
W GIRDER
W COLUMN
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
Action Fields
Field Name
Horizontal Load Textbox
Sign off document
Action
Data Condition and Validation
On text leave:
- If value is greater than 0, display “Connection not
supported” in Sketch Pane.
Page 5 of 18
MODULE
--Module Title--
Connection Type
--Change Description--
SR-UI-PRT-01
HSS COLUMN/W COLUMN
Plate Tab
Screen
Layout
Note: Refer to existing functionality of field properties.
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name
Cap Plate Checkbox
Action
Data Condition and Validation
On tick:
Directly Welded
- Enable all Cap Plate Properties
Flange Plate
- Enable Clearance Textbox
- Disable Thickness and Grade
--Change Description--
SR-UI-PRT-03
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Sign off document
Page 6 of 18
Input Fields
Field Name/ Control
Data Type/Length/Values
State
Description
Format
Specific
Applicability
--No change--
Enable
--No change--
--No change--
--No change--
Stiffener Plate Checkbox
--Change Description—
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
Action Fields
Field Name
Action
Stiffener Plate Checkbox
On Tick:
Hide Shear Plate Clip Textbox in Web Connection Tab:
--Change Description--
SR-UI-PRT-05
Screen
Layout
Applicability
Sign off document
Reference:
Page 7 of 18
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name/ Control
Action
Stiffener Plate Checkbox
For Two-Way Moment Connection to W Column Flange:
- On check:
- Doubler Plate Type will be Enabled
- Values:
- Extended (Default)
- Unextended
For Perpendicular & Three-Way Moment Connection to W Column Flanges and Web see below:
Connection
No. of Stiffener
Plates
1
Directly Welded
2
0
Flange Plate
1
No. of Doubler Plates-
Type
State
Disabled
Disabled
Enabled
Disabled
Disabled
Disabled
Enabled
Disabled
Default Value
Extended
Unextended
Extended
Unextended
Extended
Unextended
Extended
Unextended
--Change Description--
SR-UI-PRT-13
Filler Plate Properties
Beam 1 / 2 / 3 / 4
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Input Fields
Field Name/ Control
Data Type/Length/Values
Filler Plate Checkbox
Default: Unticked
Filler Plate Thickness Textbox If Filler Plate Checbox is ticked:
- Default value: 1/4”
Number of Fillers Dropdown
Otherwise: NA
If Filler Plate Checbox is ticked:
Values:
- Single
- Multiple (Default)
State
Description
Format
Specific
Applicability
Enabled
NA
NA
NA
Enabled on tick of Filler Plate
Checkbox.
Otherwise, disabled
Field Description:
Filler Plate Thickness
(t)
#/#”
NA
Enabled on tick of Filler Plate
Checkbox.
Otherwise, disabled
Field Description:
Number of Filler
Plates
N/A
NA
Otherwise: NA
Sign off document
Page 8 of 18
--Change Description—
Beam 1 / 2 / 3 / 4
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name
Thickness Textbox
Type Dropdown List
MODULE
Action
Data Condition and Validation
On text leave:
- Thickness of Flange Plate on other beams will copy the modified value.
On Change to Wrap-around:
- If thickness value is not equal to all beams, the min. value should be displayed.
--Module Title--
Connection Type
--Change Description--
SR-UI-BLT-01
Screen
Layout
Note: Refer to existing functionality of field properties.
Applicability
Sign off document
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
Page 9 of 18
Connection Type
--Change Description--
SR-UI-BLT-03
For Vertical and Horizontal Shear:
Screen
Layout
Reference: LID-2010-56
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
Action Fields
Field Name
Row Lines Textbox
Action
Data Condition and Validation
On Text leave:
If Row Lines of both beams is greater than 1:
- Row Spacing of Beam 1 will be enabled and Beam 2 will be disabled.
Row Spacing of Beam 1 and Beam 2 should be equal. Beam 2 will copy the value of Beam 1.
Otherwise, refer to below state of Row Spacing:
* Beam with greater than 1 value of Row lines:
- Row Spacing is enabled
* Beam with 1 value of Row lines:
Row Spacing is disabled with 0” value.
Sign off document
Page 10 of 18
MODULE
--Module Title--
Connection Type
--Change Description--
SR-UI-WLD-01
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
Connection Type
--Change Description--
SR-UI-WLD-10
Screen
Layout
Applicability
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Input Fields
Field Name/Control
Weld Length Textbox
Data Type/Length/Values
Shear Plate weld to Primary Web:
𝑊𝑥 = 𝐷e𝑝𝑡ℎ 𝑜𝑓 𝐵𝑒𝑎𝑚𝑥 + 2*𝑡𝑓𝑖 – 2(Clip)
State
Description
Format
Specific
Applicability
--No Change--
--No Change--
--No Change--
--No Change--
Where:
Wx – Weld length of Shear Plate
Depth of Beamx – Depth of Beam
tfi – Thickness of Filler plate(s)
Clip – Clip value of Shear Plate
Sign off document
Page 11 of 18
MODULE
--Module Title--
Connection Type
--Change Description--
SR-UI-EXC-01
Process
Flow
Detailed
Process
Flow
Tool Bar
Import Icon
Job Manager Icon
Save Icon
Load Icon
Connection Creator Icon
New Icon
Screen
Layout
Get Icon
Check Icon
Reset Icon
Applicability
Help Icon
Report Icon
Reference:
Connection No.:
Connection Type:
Joint:
Flange Connector:
Flange Connector Type:
Web Connector:
Web Connector Type:
FUNCTIONAL SPECIFICATIONS
Action Fields
Field Name
New Icon
Action
Data Condition and Validation
On Click:
• If there are unsaved connection(s) on Multiple List View, confirmation message
will prompt:
*Click Yes to save all connections as (file extension)
*Click No to exit Multiple List View and open Connection Selector Window.
*Click Cancel to resume Multiple List View.
• If all connections are already saved, Connection Selector will be displayed.
Load Icon
Sign off document
On Click:
Template Validation:
• Open Load Window.
• The following should be satisfied:
1. Check if there is Excel application installed:
Page 12 of 18
- MS Excel
- OpenOffice Calc
- LibreOffice Calc
Otherwise, display below prompt message:
*.(file extension) file is displayed by default. Select excel format in dropdown
list options. See below:
2. The format and properties on the Excel File should be the same with
Template otherwise, display prompt message on click of Open Button:
*Upon open of excel file from Load Window, (SOFTWARE) will validate the
contents and display the connections on Multiple List View.
*If Multiple List View is already active and there are unsaved connections,
display below prompt message:
*Click OK to close prompt message.
• All columns of Job Details Sheet (except INT and Fabricator) should be filled out
otherwise, display below message on click of Open Button:
*Click Yes to save all connections in Multiple List View as (file
extension) (See Save Icon existing functionality)
*Click No to exit Multiple List View and open window file browser.
*Click Cancel to close the prompt message.
*User can only load one (1) excel file only.
*Click OK to close prompt message.
• Connection is supported otherwise, display below prompt message:
• Below required fields in excel should be filled out with valid values:
- Beam Size
- Primary Size
- Primary Type
- Connector type
- ID# Column
Otherwise display below prompt message:
*Click OK to close prompt message.
• ID# Column value should be unique. The row of duplicate ID# value will not be
retrieved.
• Columns should not contain merged cells.
*Click OK to close prompt message.
• Below will be retrieved as fraction if value from Excel is decimal:
- Gage
- Gage at Primary side
- Gage at Beam side
- Gap
- Leh
- Lev
- Weld Size
- Plate Thickness
Job Validation:
- If job in Excel is not yet included in Job Manager, display below prompt
message:
Sign off document
Page 13 of 18
*Click Yes (see FSD for its existing functionality)
*Click No, (software) will not save the job
- (software) will will still load the data from excel file
- Use (software) default for those properties that is not present in the excel
file
Import icon
On Click:
• If there are unsaved connection(s) on Multiple List View, confirmation message will
prompt:
See FSD for Import Condition and Validation
*Click Yes to save all connections in Multiple List View as (file extension) (See
Save Icon existing functionality)
*Click No to exit Multiple List View and proceed to functionality of Import
Icon.
*Click Cancel to close prompt message
Save icon
On Click:
Dependency:
• Open Save File Window:
Single View
1. Always enable
Multiple List View
1. Initially disable. Will be enabled if below conditions are satisfied:
- At least one (1) row is selected.
- Remarks field is either “Processed”, “Designed”
File Validation:
• (FILE EXTENSION) will not be saved if the excel file is open. Below prompt
message will be displayed:
- The default location is Documents/filename.(file extension).
- The default filename is the connection code.
- Write the filename on Filename column of Multiple List View.
- Remarks Column will be updated:
• If filename already exists or there are duplicate filenames in the Multiple List
View, numbering will be added in the filename
.
- Status of connections will be written on Excel upon save of (file
extension) with its corresponding color:
*Failed – Red
*Verify – Orange
*Passed – Green
- On click of Save button, save connection as (file extension) and display
below prompt message:
- If saved from Single View, Filename Column on Multiple List View will
also be updated.
Job Manager Icon
On Click:
Condition:
• Display Job Manager Window:
• If properties of the active job is modified, display below prompt message:
*Click Yes to apply the changes on the current connections
*Click Cancel to Close Prompt message.
*Click No to display below prompt message:
Sign off document
Page 14 of 18
*Click no close prompt message.
*Click Yes and changes will not be applied on the current connection
but will be used if new connection is created. Below prompt message
will be displayed.
*Click OK to close prompt message.
Connection Creator
Icon
On Click:
See 19.0.0 SOD for the condition and validation
• If there are unsaved connection(s) on Multiple List View, confirmation message
will prompt:
*Click Yes to save all connections in Multiple List View as (file extension) and
save status in the Excel File
*Click No to exit Multiple List View and proceed to functionality of
Connection Creator Icon.
*Click Cancel to close the prompt message.
• If all connections are already saved, proceed to functionality of Connection Creator
Icon.
Get Icon
On Click:
See FSD for the condition and validation
• If there are unsaved connection(s) on Multiple List View, confirmation message
will prompt:
*Click Yes to save all connections in Multiple List View as (file extension) and
save status in the Excel File
*Click No to exit Multiple List View and proceed to functionality of Get Icon.
*Click Cancel to close the prompt message.
Reset Icon
Check Icon
• If all connections are already saved, proceed to functionality of Get Icon.
---Disabled--Single View
Dependency:
On Click:
Display Check Form Window.
Single View
- Always enable
Multiple List View
- Always Disable
Report Icon
On Click:
Dependency:
- Display Print Options.
Single View
- Always enable
Multiple List View
- Initially disable. Will be enabled if below conditions are satisfied:
1. At least one (1) row is selected.
2. Remarks field is either saved, “Processed” or “Designed”
See FSD for other Condition and Validation
Sign off document
Page 15 of 18
*On click of ‘Save as PDF’, Save File Window will open and user can save the
reports as PDF. Once the Report is saved, display below prompt message:
Single View:
Display Print Options.
*On click of ‘Print Preview’, Print Options will close and Calculations print
preview will open.
*On click of ‘Save as PDF’, Save File Window will open and user can save the
reports as PDF. Once the Report is saved, display below prompt message:
Help Icon
On Click:
Display User Guide.
Multiple List View
Status
Dropdown List
Delete Icon
Remarks Dropdown List
Search Textbox
Main Checkbox
Search Icon
Connection Header
Header
Checkbox
Screen
Layout
Filename
Column
Connection
Checkbox
Primary
Column
Secondary
Column
Load
Column
Processed
Connections Label
Successful
Total Connections
Connections
Label
Label
Applicability
Input Fields
Field Name
Sign off document
Count Column
with Eye Icon
Web Conn Type
Flange Conn Type
Dropdown List
Dropdown List
Column
Column
Flange Connector
Web Connector
Dropdown List
Dropdown List
Column
Governing Check
Column
Remakrs Column
Status Column
Previous Page
Process Button
Next Page
Unsuccessful
Connections Link
One-Way Shear Connections Except Vertical & Horizontal, Concrete and Beam Splice Connections
Data Type/Values
State
Description
Format
Page 16 of 18
Search Textbox
Filename Column
Web Connector
Dropdown List
Web Conn Type
Dropdown List
Flange Connector
Dropdown List
Flange Conn Type
Dropdown List
Alphanumeric and
special characters.
Alphanumeric and
special characters.
Enable
• Allows the user to search Primary and Secondary size, Load and Governing Check
NA
Enable
• Initially blank
• Once processed, display the default filename (Connection Code).
• If this field is left blank, on leave, return default value.
NA
NA
Enable
See Action Fields table
NA
NA
Enable
See Action Fields table
NA
—Select—
---Always Disable---
NA
NA
—Select—
---Always Disable---
NA
NA
Action Fields
Field Name
Search Icon
Action
On Click or on press of Enter key:
Data Condition and Validation
Initially disable; will be enabled if Search Textbox has value.
- Display the connection (from all the pages) that will match the entered value in
Search Textbox
Delete Icon
On Click:
Initially disable; will be enabled if Search Textbox has value.
Delete all values in Search Textbox.
Status Dropdown List
On Select:
• Show only rows with status (from all the pages) that will match the selected value.
• If the selected value does not exist on Status column, display blank on Multiple List
View table.
All Remarks
Dropdown List
On Select:
• Show only rows with remarks (from all the pages) that will match the selected
value.
• If the selected value does not exist on Remarks column, display blank on Multiple
List View table.
Main Checkbox
Dependency:
- Initially disable; enable if there is processed or designed connection.
• Lists down status of all Processed Connections in the following order:
- ALL CONNECTION STATUS
- Passed
- Verify
- Failed
Dependency:
- Initially disable; enable if there is processed or designed connection.
• Lists down remarks of all Processed Connections in the following order:
- ALL REMARKS
- New
- Processed
- Designed
On Tick:
All connections on the current page will be selected.
Header Checkbox
On Ticked:
All connections under this header will be selected.
Connection Checkbox On Tick:
Corresponding connection will be selected.
Eye Icon
On Click:
Click to redirect on Single View.
Dependency:
- Initially disable; enable if connection is processed.
NOTE: Fields in Single View are enabled.
Web Connector
Dropdown list
Web Conn Type
Dropdown list
On Select:
• By default, the displayed value is the retrieved connector in Excel.
• Selected connection type will be displayed
• Display values based on below order:
- Connection Angle (2L)
- Connection Angle (L)
- Shear Plate
- End Plate
On Select:
By default, the displayed value is the retrieved connector type in Excel.
• Display the selected value.
Dependency:
• It will be updated based on the selected value on Web Connector Dropdown list:
Connection Angle:
- Bolted/Bolted
- Welded/Bolted
- Bolted/Welded
Shear Plate:
- Regular
- Partial Depth
- Full Depth
- Through Plate
• If End Plate is selected as connector, Type will be disabled with —Select— value.
Sign off document
Page 17 of 18
Status Column
On Click:
Display Check Form Window. Apply Design button and Apply Capacity button should
be hidden.
Connection Status:
- “Passed”: Green
- “Failed”: Red
- “Verify”: Orange
See FSD/Prev SOD for other check form condition and validation
On click of “Design” button:
- Design form should be displayed
- If there are modified properties, on switch to multiple list view, UCV and
Governing Check will be updated.
- Remarks will be changed to “Designed”
Process Button
On Click:
Dependency:
• Display computed UCV and Governing check, and Status.
• Remarks will be “Processed”.
• Sort list by Connection header in ascending order.
• Filename will be enabled and will have default value.
• No. of Processed connections (Successful and unsuccessful) will be updated.
• Display below prompt message if there are unprocessed connections:
• Initaly disable, will be enabled if the following are satisfied:
- At least one (1) row is selected.
- Atleast 1 of the selected is with “New” remarks
• (software) will check also other page if there is/are selected connection to
process.
*On click of OK, if there are unprocessed connection:
- enable Unsuccessful connections link
- move all unprocessed connections from Multiple List View to
Unsuccessful window
Unsuccessful
Connections Link
•It Displays the total number of unsuccessfuly processed/retrieved connections
On Click:
Display the unsuccessful window and display the following in the form
- All Unsupported Connections
- All Unsuccesssful Connections
Previous Page
Next Page
On click:
Previous number will be highlighted and MLV will display connection under the page
#
On click
Next number will be highlighted and MLV will display connection under the page #
Dependency:
• Enabled if both or one of below conditions is satisfied:
- there are unsupported connections from Excel template upon load
- there are unprocessed connections from MLV upon click of Processed
button
Otherwise, disabled.
Display 200 items only per page.
If items is less than or equal to 200, page numbering will be hidden.
Display initially the available page as 1, 2, 3, 4 and 5.
If pages is more than 5, display the pagination as below
If the display page is the last 3 pages, display pagination as below.
If first page is displayed in the MLV, disable the Previous page arrow.
If last page is displayed in the MLV, disable Next page arrow.
Table #1
--Table TitleSample table used as reference
Prepared by (S.A.)
Verified by (B.A.)
Approved by (P.M.)
Sign off document
Gloriane R. Mangindin
Page 18 of 18