THE UNIVERSITY OF AUCKLAND
Insert directorate or faculty
Technical Specifications
Sponsor: Insert name of project sponsor
The University of Auckland
ITSS – Technical Specifications
Document History
Author Version Date Revision
Author Author
0.1 1.0
20/01/2004 09:50 10/29/2008 4:45:00 AM
Document created. Note the changes.
Table of Contents
Introduction .............................................................................................................................5
Objective...............................................................................................................................5 System Overview..................................................................................................................5 Technical Summary ..............................................................................................................5 Human Resources .................................................................................................................5 Audience ...............................................................................................................................5 Related Documents ...............................................................................................................5 Assumptions .........................................................................................................................5 Programming Specifications ...............................................................................................5 Programming Languages ......................................................................................................5 Programming Tools ..............................................................................................................5 Algorithms ............................................................................................................................5 Security .....................................................................................................................................6 Screen Definitions .......................................................................................................................6 ...................................................................................................................6 Screen shots ..........................................................................................................................6 Client-side Validation ...........................................................................................................7 ...................................................................................................................7 Screen shots ..........................................................................................................................7 Client-side Validation ...........................................................................................................7 System Requirements..................................................................................................................8 Client Side Requirements .....................................................................................................8 Server System Requirements ................................................................................................8 System Architecture .............................................................................................................8 Backup ..................................................................................................................................8 Testing ..................................................................................................................................8 Administration ......................................................................................................................8 Support and Maintenance .....................................................................................................8 Portability .............................................................................................................................8 Platforms...............................................................................................................................8 Expandability........................................................................................................................9 Reporting ..............................................................................................................................9 Testing ..................................................................................................................................9 Performance ..........................................................................................................................9 Redundancy and Recovery ...................................................................................................9 The Data Model ..........................................................................................................................9 Stored Procedures .................................................................................................................9 Table Specifications .............................................................................................................9 ...................................................................................................................................10 Function ..............................................................................................................................10
Created 20/01/2004 9:50:00 a.m. Name of system or software Page 2 of 13
The University of Auckland
ITSS – Technical Specifications
Indexes and Triggers ..........................................................................................................10 Fields ..................................................................................................................................10 ..................................................................................................................................11 Function ..............................................................................................................................11 Indexes and Triggers ..........................................................................................................11 Fields ..................................................................................................................................11 Appendix A ...............................................................................................................................12 Data Relationship Model ....................................................................................................12 Appendix B ...............................................................................................................................12 Data Flow Model ................................................................................................................12 Appendix C ...............................................................................................................................13 Appendix D ...............................................................................................................................13
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 3 of 13
The University of Auckland
ITSS – Technical Specifications
Notes to the author: Delete this section before finalising the document
To get the most out of this template it’s probably best if you customise it for the job at hand. Projects can vary widely in their type and complexity. The following ideas may be worth considering when writing the technical specs. Consider writing the specs in the present tense. In other words describe the product as though it already existed. This makes it easier to write, easier to maintain and it remains useful longer. (C/o Matthew Kendall of Ionocom Communications Inc). A technical specification describes the internal implementation of the program. It talks about data structures, relational database models, choice of programming languages and tools, algorithms, etc. It differs from functional specs, which state what the system is to DO, entirely from the user's perspective. It doesn't care (within reason) how the thing is implemented. One benefit of technical specs is consistency. For example using the same name for buttons that do the same thing in all the screens. A web specification is a detailed description of the constraints and elements that will go into the web's design and implementation. The specification lists what pieces of domain information will be presented as well as any technical or policy limitations on that presentation. o o o o o o For example, one part of a specification might state that the graphics at the site must be under a certain size or must be a certain format. Establish technical and policy constraints early so that the web doesn't require costly re-work. Identify technical constraints based on graphics, page size, and applet processing based on your best evaluation of your expected audience's equipment. Create a consistent look and feel for the web. Separate information into manageable page-sized chunks. Provide cues for the reader about the web's information structure and contents, context, and navigation.
Delete this section before finalising the document _____________________________________________________________
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 4 of 13
The University of Auckland
ITSS – Technical Specifications
Introduction
Objective The objective of this specification is to set out the technical details of the name of software or system. It explains how the system will be built and deployed. It excludes non-technical matters such as project management, business cases, human resources, or training. These are covered by other documents. Describe the overall functionality of the system and how it fits with other key systems and business objectives. Briefly describe the technical features of the system. Specify features that are unique or require additional time or skills to implement. Record the people and their roles who will be directly involved in building, testing, etc the system. The audience for this specification includes: Related Documents Assumptions Developers Testers Project manager Project owner Functional specifications Project plan Business case Project management
System Overview Technical Summary Human Resources Audience
Please refer to the following documents:
List the assumptions that influence the design and deployment decisions.
Programming Specifications
In this section enter the details of how the developers will build the system. Programming Languages List the programming languages, if any, that are to be used for the project. For example: Programming Tools ColdFusion Visual Basic Active Server Pages SQL
List the programming tools, if appropriate, that are to be used for the project. Dreamweaver SQL tools Test tools e.g. link checkers for web pages
Algorithms
List the algorithms, if any, to be used in this system.
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 5 of 13
The University of Auckland
ITSS – Technical Specifications
Security
Describe the proposed security around the system. Please describe the security model for the system and the levels and types of security available. For example: NT or other operating system security Database security Modularity Scalability The security definition types are: o o User Profiles: Each user has an individual User Profile, which in turn is linked to one or more Roles. Roles: To each Role, you add one or more Permission Lists, which ultimately control what a user can and can't access. Permission Lists Access Profile: The Roles are then attached to a User Profile, and the user connects to the database by way of the specified Access Profile
o o
User Profiles: A User Profile is a set of data describing a particular user system. On the other hand, some of the information, such as the email address, is descriptive, and some of the information is a preference. A User Profile inherits most of its permissions through the Role(s) or roles that have been assigned to the User Profile. Data permissions, or row-level security, appear either through a Primary Permissions list or a Row Security Permissions list.
Screen Definitions
Insert a bird’s-eye view of the system. For network systems you could use a network diagram. Refer to appendix C. For web systems you could use a page flow diagram. Refer to appendix D. Give the name and title of the screen. Description: Describe how the screen is used in the system. Initialisation: Describe initialisation of the screen in “Add” and “Edit” modes. Validation: Describe validation for controls. Data source: Define the table and field of each of the data sources. Screen shots Insert shots of the screen. HTML mockups can be used. Adding notes to the developer can be very useful.
Page 6 of 13 Name of system or software
Created 20/01/2004 9:50:00 a.m.
The University of Auckland
ITSS – Technical Specifications
For example:
Client-side Validation
Make notes on client-side validation for this screen. These should tally with the validation notes in the database table. Give the name and title of the screen. Description: Describe how the screen is used in the system. Initialisation: Describe initialisation of the screen in “Add” and “Edit” modes. Validation: Describe validation for controls. Data source: Define the table and field of each of the data sources.
Screen shots
Insert shots of the screen. HTML mockups are typically used. Adding notes to the developer can be very useful. For example:
Client-side Validation
Make notes on client-side validation for this screen. These should tally with the validation notes in the database table.
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 7 of 13
The University of Auckland
ITSS – Technical Specifications
System Requirements
Specify the hardware and software requirements for the system. Make note of any unique or potentially problematic requirements. Client Side Requirements Specify the minimum client hardware and software requirements. Server System Requirements Operating system: Unix, NT Memory Hard drive storage
Specify the minimum server hardware and software requirements. For example: Operating system: Unix, NT Number of processors Memory Hard drive storage
System Architecture
Describe the system architecture. For example: completely server-based architecture. Clients can be nearly any kind of Internet access device:· Web browser running on a PC, Macintosh, or Linux machine· Wireless device or cell phone. External or third-party system with XML/HTTP protocols the client can be any Internet device that uses standard Internet technologies such as HTTP, Hypertext Markup Language (HTML), and XML to communicate with the PeopleSoft Internet Application Server. The Internet Application Server (IIS) tier is the heart of Internet Architecture. Commercially available web servers that support Java Servlet execution can be used to provide the execution environment Lightweight Directory Access Protocol (LDAP) to authenticate end users and manage their system access privileges. SQL Access Manager - Manages all interaction with the relational DBMS via SQL. Oracle, Informix, IBM DB2, Sybase, and Microsoft SQL Server. etc
Backup Testing Administration Support and Maintenance Portability Platforms
Describe the backup functions and tools required. Describe the unit and system testing programme and unique testing requirements. Describe how the system is administered. Describe who would be available to provide technical support over and above the system administrators. Also, what scheme of support is planned. How portable will the system be to other platforms? List the platforms that the system runs on.
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 8 of 13
The University of Auckland
ITSS – Technical Specifications
Expandability Reporting Testing
How scalable is the system to meet future needs? Describe how reports will be generated from or about the system. Overall strategy Testing tools Tools to be developed Acceptance criteria for handoff to QA UAT testing Capacity Response times Disk mirroring for all product databases Dual channelling of all disk controllers Enterprise servers capable of automatic recovery on loss of Processor, System memory.
Performance
Describe expectations regarding the system’s performance.
Redundancy and Recovery
The Data Model
Describe the overall data structure. Use diagrams to explain. For example: Stored Procedures What stored procedures are needed? : Function: : Function: Table Specifications This section describes in detail each of the database tables.
Created 20/01/2004 9:50:00 a.m. Name of system or software
Page 9 of 13
The University of Auckland DRAFT ITSS – Technical Specifications ____________________________________________________________________________________________________________________________________________________
Function Indexes and Triggers Describe how the table is used in the system. Define the indexes for the table. Fields
Field name
Index name. Trigger name and behaviour.
Define the triggers for the table. These are the fields for the table with their details. For example:
How used and populated Type Structure Default Foreign key? Validation
InquiryID Approval_Code Status_Code DateLogged
Autonumber Alphanumeric Text Date/Time
Primary key
Default value
Yes/No, to what table?
Yes/No. Specify the message.
Short date
____________________________________________________________________________________________________________________________________
Created 20/01/2004 9:50:00 a.m. Name of system or software Page 10 of 13
The University of Auckland DRAFT ITSS – Technical Specifications ___________________________________________________________________________________________
Function Indexes and Triggers Describe how the table is used in the system. Define the indexes for the table. Fields Index name. Trigger name and behaviour. Define the triggers for the table. These are the fields for the table with their details. For example:
How used and populated Type Structure Default Foreign key? Validation
Field name
InquiryID Approval_Code Status_Code DateLogged
Autonumber Alphanumeric Text Date/Time
Primary key
Default value
Yes/No, to what table?
Yes/No. Specify the message.
Short date
____________________________________________________________________________________________________________________________________
Created 20/01/2004 9:50:00 a.m. Name of system or software Page 11 of 13
The University of Auckland DRAFT ITSS – Technical Specifications ___________________________________________________________________________________________
Appendix A
Data Relationship Model Example of a Data Relationship Model.
Appendix B
Data Flow Model Example of a Data Flow Model
__________________________________________________________________________________
Created 20/01/2004 9:50:00 a.m. Name of system or software Page 12 of 13
The University of Auckland DRAFT ITSS – Technical Specifications ___________________________________________________________________________________________
Appendix C
Example of a network diagram of the system.
Appendix D
Example of a page flow view of the system.
__________________________________________________________________________________
Created 20/01/2004 9:50:00 a.m. Name of system or software Page 13 of 13
sc107
Views: 83 | Downloads: 1
JankeT
Views: 45 | Downloads: 0