Professional Documents
Culture Documents
[Project Name]
Document Confidentiality.
All right reserved. The content of this document is property of Softtek®, confidential and copyrighted. Any reproduction in
whole or in part is strictly prohibited without the written permission of Softtek®.
This document is subject to change. Comments, corrections or questions should be directed to the author.
Instructions: The text typed between square brackets ([ ]) or in the color used in this paragraph, has been included to
provide a guide to the author of the document and has to be replaced or eliminated before publishing the document. This
template is of exclusive use of the Softtek personnel.
Technical Specification
Document Summary
Purpose
[Specify the purpose of this document, in the overall project documentation scope, and briefly
describe the structure of the document.]
Audience Purpose
Revision Chart
The following chart list the revisions made to this document. Use this to describe the changes and
additions each time this document is re-published. The description should include as much detail
as possible, as well as, the reviewers who request the changes.
Technical Specification
Contents
Overview...................................................................................................................................................................................4
Design Issues and Strategies..............................................................................................................................................4
Structure...................................................................................................................................................................................4
Directory Structure...............................................................................................................................................................4
Package Structure...............................................................................................................................................................5
Standards.................................................................................................................................................................................5
Support Subsystems................................................................................................................................................................5
Data Model Dictionary..............................................................................................................................................................5
Class Diagram..........................................................................................................................................................................5
Use Cases Realization.............................................................................................................................................................6
Issues.......................................................................................................................................................................................6
Sign-Off....................................................................................................................................................................................6
Appendix A...............................................................................................................................................................................7
[Use Case Id – Use Case Name]........................................................................................................................................7
Overview
[Provide a high-level overview of the project from a technical perspective; describe the
capabilities needed by the stakeholders, and the target users, and why these needs exist.]
[Describe technical design issues and specific strategies that have been chosen. This should be
at a more detailed level (i.e., at a class or code level) than the architecture specification
document. Discuss the technical design strategy chosen to handle issues such as:]
[State management.]
[Transaction flow management.]
[Language support.]
[Error and messages mechanism.]
[Data persistence.]
[Data transactions.]
[Permit only authenticated and authorized users to view, create, modify, or delete
information managed by the application.]
[Security, including integration with Single Sign-on.]
[Session time-out after a mutually agreed upon period of user inactivity.]
[Termination of any active sessions interrupted by power failure, system “crash,” network
problem, or other anomaly, or when the user interrupts the connection.]
[Integration with other components of the e-Business Framework.]
[Integration with third-party software used in the application.]
[Validation of all inputs and outputs prior to use to avoid data-driven attacks such as
“cross-site scripting” and “SQL injection”.]
[Any other technical strategy chosen.]
Structure
Directory Structure
[Describe the folder structure and descriptions of contents defined for this application or include a
directories diagram; from the application root directory registered in the e-Business Application
registry.]
Package Structure
[Include a package diagram and provide a detailed description of the package organization.]
Standards
The coding standards and naming conventions used for this project are located in the next
document: [Insert the file or location of the document that contains the project coding standards
and naming conventions.]
Support Subsystems
[Provide information about the technical subsystems components designed or reused in the
application and any third-party systems or shared services that the application uses. Provide
descriptions of the application components, preferably including class diagrams.]
Source Description
The entity relationship model diagram is located in the next document: [Insert the file or location
of the document that contains the entity relationship model diagram.]
Class Diagram
[Include the class diagram defined for the application architecture.] ,
The class diagram is located in the next document: [Insert the file or location of the document that
contains the class diagram.]
Issues
[Describe the issues aroused and their status. Assign a number to each issue, describe it, assign
an owner (who is responsible for determining a resolution and when), and the current status. If a
technical decision has not been decided or a risk has not been controlled yet, include the issue in
this section and provide information about the options and the suggested strategy.]
Sign-Off
Signature Name and Title Date Comments
[Name]
[Business User Title]
[Name]
[IT User Title]
[Name]
[Sponsor Title]
Appendix A
[Include a detailed sequence diagram for the scenarios identified in the use case, because of the
use case complexity sequence diagram can be broken into several sequence diagrams one for
each primary and secondary scenarios. Add any additional diagrams needed to clearly define or
illustrate aspects of the use case. Add the needed detail to specify all the information required to
serve as detail component specification.]
Derived Requirements
[Provide a textual description that collects all requirements, such as non-functional requirements,
on the use case realizations that are not considered in the design model, but that need to be
taken care of during implementation.]