H2: SOFTWARE TECHNICAL SPECIFICATION TEMPLATE
YOUR LOGO
PROJECT NAME
AUTHOR
DATE
Version 0.0.0
REVISION HISTORY
DATE VERSION DESCRIPTION AUTHOR
1
Table of Contents
INTRODUCTION ......................................................................................................................... 3
PURPOSE ..................................................................................................................... 3
INTENDED AUDIENCE AND PERTINENT SECTIONS ............................................................. 3
PROJECT SCOPE .......................................................................................................... 3
DOCUMENT CONVENTIONS .......................................................................................... 3
REFERENCES ................................................................................................................ 3
DESCRIPTION ............................................................................................................................. 4
PRODUCT PERSPECTIVE ................................................................................................. 4
FEATURES ..................................................................................................................... 4
USER OVERVIEW ........................................................................................................... 4
OPERATING ENVIRONMENT........................................................................................... 4
CONTRAINTS: IMPLEMENTATION / DESIGN ..................................................................... 4
DOCUMENTATION ........................................................................................................ 4
ASSUMPTIONS / DEPENDENCIES .................................................................................... 4
SYSTEM FEATURES ...................................................................................................................... 5
SYSTEM FEATURE 1 ........................................................................................................ 5
SYSTEM FEATURE 2 ........................................................................................................ 5
SYSTEM FEATURE 3 ........................................................................................................ 6
REQUIREMENTS OF EXTERNAL INTERFACE ................................................................................ 7
USER INTERFACES ......................................................................................................... 7
HARDWARE INTERFACES ............................................................................................... 7
SOFTWARE INTERFACES................................................................................................. 7
COMMUNICATION INTERFACES .................................................................................... 7
ADDITIONAL NONFUNCTIONAL REQUIREMENTS ...................................................................... 8
PERFORMANCE ............................................................................................................ 8
SAFETY ........................................................................................................................ 8
SECURITY ..................................................................................................................... 8
SOFTWARE QUALITY...................................................................................................... 8
APPENDICES .............................................................................................................................. 9
APPENDIX A: GLOSSARY OF TERMS ............................................................................... 9
APPENDIX B: ANALYSIS DOCUMENTATION .................................................................... 9
APPENDIX C: ISSUES .................................................................................................... 9
2
INTRODUCTION
PURPOSE
Identify and describe scope of product whose technical specifications are being documented, and
describe desired outcome.
INTENDED AUDIENCE AND PERTINENT SECTIONS
Describe each type of reader, including developers, users, testers, writers, marketing, etc., and outline
which portions of document are crucial to their department.
PROJECT SCOPE
Describe relevant benefits, objectives, and goals and how they relate to corporate goals and strategies.
DOCUMENT CONVENTIONS
Describe any naming or structural conventions employed throughout document and how they benefit
reader.
REFERENCES
List any referenced document names or links.
3
DESCRIPTION
PRODUCT PERSPECTIVE
Provide context and origin of product, along with expected functionality.
FEATURES
List main features with brief description.
USER OVERVIEW
Define groups, and describe user characteristics.
OPERATING ENVIRONMENT
Illustrate where software will function: hardware platform, operating systems, and other software
components or applications with which it must work in conjunction.
CONTRAINTS: IMPLEMENTATION / DESIGN
Describe limitations impacting development.
DOCUMENTATION
Describe content, mode of delivery, and standards.
ASSUMPTIONS / DEPENDENCIES
Detail all assumed factors (not known facts) that could potentially impact technical specifications set
forth. Include external factors.
4
SYSTEM FEATURES
SYSTEM FEATURE 1
DESCRIPTION
AND PRIORITY
STIMULUS /
RESPONSE
SEQUENCES
FUNCTIONAL
REQUIREMENTS
SYSTEM FEATURE 2
DESCRIPTION
AND PRIORITY
STIMULUS /
RESPONSE
SEQUENCES
FUNCTIONAL
REQUIREMENTS
5
SYSTEM FEATURE 3
DESCRIPTION
AND PRIORITY
STIMULUS /
RESPONSE
SEQUENCES
FUNCTIONAL
REQUIREMENTS
6
REQUIREMENTS OF EXTERNAL INTERFACE
USER INTERFACES
Describe product / user interface characteristics, including standards, style guides, constraints,
functionality, and sample screens if applicable.
HARDWARE INTERFACES
Describe product / hardware interface characteristics, nature of interactions, and communication
protocols.
SOFTWARE INTERFACES
Describe product / other software interface characteristics, including component names and versions,
databases, operating systems, libraries, tools, etc. Specify any constraints, along with nature of
communications and what data is coming in and being disseminated.
COMMUNICATION INTERFACES
List requirements of communication functions: email, browsers, servers, forms, etc. Describe standards
employed, security or encryption measures, data transfer rates, and synching.
7
ADDITIONAL NONFUNCTIONAL REQUIREMENTS
PERFORMANCE
Specify performance requirements. For additional clarity, provide rationale.
SAFETY
Specify safety requirements. Define safeguards and systems employed. Identify external policies and
regulations impacting safety requirements.
SECURITY
Specify security requirements. Define safeguards and systems employed. Identify external policies and
regulations impacting safety requirements.
SOFTWARE QUALITY
List other characteristics crucial to success of product. List each by describing its relation to product, being
quantitative, specific, and verifiable.
8
APPENDICES
APPENDIX A: GLOSSARY OF TERMS
Define all terms and unique acronyms employed throughout document and specific to project.
APPENDIX B: ANALYSIS DOCUMENTATION
List file / document names / provided links to all diagrams, models, additional findings pertinent to
technical specification development.
APPENDIX C: ISSUES
List all unresolved issues, TBDs, pending decisions, findings required, conflicts, etc.
ISSUES
ID DESCRIPTION PARTY RESPONSIBLE