Get documents about "______title_______ Document
Document Sample
Implementation Specification
for
Product XYZ Version A Release B
Last Updated: August 14, 2010
(This date is automatically updated to the Last Saved Date when
the Table of Contents is regenerated (select all and right mouse
click in the document, select the Update Fields option (or select F9)).
To just update the Date and Time field, highlight the date
and time, do a right mouse click, and select “Update Field”. This should
be done after the document has been updated and saved.
This will also work on the Date and Time and Page
Number fields in the footer of the document
The Table of Contents must be regenerated every time the document
is saved. If the user chooses to manually enter the dates, as opposed
to using automatically generated dates, then both the date on the
cover and the dates in all footer sections must be updated manually. )
Owner: name
Telephone: number
Email: address
National Cancer Institute Center for BioInformatics
6116 Executive Blvd.
Rockville, MD 20852
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 1 of 12
1 DOCUMENT PURPOSE .................................................................................................................................. 5
2 IMPLEMENTATION OVERVIEW ................................................................................................................ 6
2.1 TEAM MEMBERS ............................................................................................................................................ 6
2.2 DESCRIPTION .................................................................................................................................................. 6
2.3 SCOPE............................................................................................................................................................. 6
2.4 ARCHITECTURE .............................................................................................................................................. 6
2.5 ASSUMPTIONS ................................................................................................................................................ 6
2.6 DEPENDENCIES ............................................................................................................................................... 6
2.7 ISSUES ............................................................................................................................................................ 6
2.8 THIRD PARTY TOOLS...................................................................................................................................... 7
3 IMPLEMENTATION CONTENTS ................................................................................................................. 8
3.1 SERVER .......................................................................................................................................................... 8
3.1.1 Algorithms ............................................................................................................................................. 8
3.1.2 Batch Processes ..................................................................................................................................... 8
3.1.3 APIs ....................................................................................................................................................... 8
3.1.4 Error Handling ....................................................................................................................................... 8
3.1.5 Database Changes .................................................................................................................................. 8
3.2 CLIENT ........................................................................................................................................................... 8
3.2.1 JSP/HTML ............................................................................................................................................. 8
3.2.2 Servlet .................................................................................................................................................... 8
3.2.3 Error Handling ....................................................................................................................................... 8
3.3 SECURITY ISSUES ........................................................................................................................................... 8
3.4 PERFORMANCE ............................................................................................................................................... 8
3.5 INTERNATIONALIZATION ................................................................................................................................. 9
3.6 INSTALLATION / PACKAGING .......................................................................................................................... 9
3.7 MIGRATION .................................................................................................................................................... 9
3.8 DOCUMENTATION CONSIDERATIONS .............................................................................................................. 9
4 UNIT TESTING ............................................................................................................................................... 10
4.1 TEST GUIDELINES ......................................................................................................................................... 10
4.2 TEST CASES.................................................................................................................................................. 10
4.3 TEST RESULTS .............................................................................................................................................. 10
DOCUMENT CONTROL ........................................................................................................................................ 11
DOCUMENT APPROVAL ...................................................................................................................................... 12
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 2 of 12
LIST OF TABLES
Table 2 – Team Members ..............................................................................................................................................6
Table 3 – Implementation Specification Document Change Log ................................................................................11
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 3 of 12
[PLEASE REMOVE THE FOLLOWING “DOCUMENT FORMAT” INSTRUCTIONS IN YOUR
RELEASE DOCUMENTATION]
Document Format
The (title) document should contain all of the sections contained in this (title) document template. DO NOT
DELETE SECTIONS THAT DO NOT APPLY TO THE PRODUCT RELEASE BEING SPECIFIED, but rather
indicate in the section that it was intentionally left blank. Leaving the section in the document rather than deleting it,
reduces confusion for reviewers who may not be sure if the section was intentionally deleted or just omitted.
This template includes red text providing directions. This text should be removed from the actual document created
using the template. The titles in this document also have red text to indicate where specific document titles need to
be provided. These titles should be changed to black text in the actual document.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 4 of 12
1 Document Purpose
In this section, describe the format and purpose of the Implementation Specification.
An Implementation Specification provides a detailed description of a feature in terms of the software that implements
that feature. The specification states the business or functional requirement that is being addressed as well as the
details and rationale of how that requirement will be met through the coding of software. The document’s primary
purpose is to assist in the development process and aid in the review and maintenance of the design and code. This
is a detailed document intended primarily for designers, developers, testers and technical writers.
This document will be maintained during the project to log decisions made as the project progresses.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 5 of 12
2 Implementation Overview
2.1 Team Members
List the team members and roles here.
Table 1 – Team Members
Role Name
Development Lead
Documentation Lead
Internationalization Lead
Solutions Manager
Test Lead
2.2 Description
Include references to the Use case Document, Requirements Specifications or other documents as applicable to
describe the feature(s) that is being developed. Requirements should be stated as a capability that needs to be added
to the product in order to solve a business problem. Features are the specific additions to the product that will fulfill
the business requirement. There may be multiple features added to the product to support a business requirement.
You may add to the feature or functional area description if you wish to augment the requirement with further detail.
2.3 Scope
This section should identify what exactly will be described within the scope of this specification, e.g., the feature
may have both a server and client sections, however the spec is only covering the server section.
2.4 Architecture
This section should present an architectural overview of the implementation. Any medium may be used to document
the architecture:
Class diagrams
Program flow diagrams
Component diagrams
Module organization
Etc.
2.5 Assumptions
List any assumptions that are needed for the implementation.
2.6 Dependencies
List any dependencies that are needed for the implementation.
2.7 Issues
List any issues that need to be addressed or called out, e.g., the implementation involves OCI calls and thus is Oracle
specific – release blah.blah will address the SQL Server implementation.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 6 of 12
2.8 Third Party Tools
List any third party tools which will be used in order to implement this feature. If the tool is new for the product,
include a reference to the New Tool Request form that must be filled out.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 7 of 12
3 Implementation Contents
3.1 Server
Put server stuff here. Include schema changes, sql calls , OS specific info if applicable, API signatures, pseudocode,
error handling ,any and all info that will be relevant and helpful for others to understand and maintain the code.
3.1.1 Algorithms
List any algorithms that will be added or affected by the feature. Describe the changes that will be made.
3.1.2 Batch Processes
List any batch processes that will be added or affected by the feature. Describe the changes that will be made.
3.1.3 APIs
Include the API signatures and their implementation detail.
3.1.4 Error Handling
Describe the error handling methods and techniques that will be used including general philosophy of when and
where exceptions will be caught, thrown, logged, etc.
3.1.5 Database Changes
State the database changes required for this feature.
3.2 Client
Put client stuff here. Include API calls, screen mockups/shots if not available in the Functional Specification,
browser specific info if applicable, OS specific info if applicable, pseudocode, error handling, any and all info that
will be relevant and helpful for others to understand and maintain the code.
3.2.1 JSP/HTML
List the JSP/HTML pages that will be added or affected by the feature. Describe the changes that will be made.
3.2.2 Servlet
List the servlets that will be added or affected by the feature. Describe the changes that will be made.
3.2.3 Error Handling
Describe the error handling methods and techniques that will be used including general philosophy of when
exceptions will be displayed or logged.
3.3 Security Issues
Document security issues that need to be addressed and how it will be resolved.
3.4 Performance
Document the implementation details of how good performance was met or maintained ( ) during the coding of this
feature. Discuss any potential performance bottlenecks and how it will be or can be resolved. Reference any
relevant performance criteria that is in the Requirements Specification and how it was met. If you know of any
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 8 of 12
Performance testing that will be performed, you can state it here and refer the reader to where the results will be
posted later in the Product Development cycle.
3.5 Internationalization
Document internationalization issues that need to be addressed and how it will be resolved. Keep in mind such
things as:
Date format
Time format
Currency
Language translations
Number separators
Display issues (e.g., field length increasing because German translations are 30% bigger)
Sorting
Using resource filed instead of hard coded strings
Etc.
3.6 Installation / Packaging
Document any changes that will need to be made to the installation program including packaging issues. List any
new files that will need to be placed on the CD image and where.
3.7 Migration
List any migration issues that need to be taken care of separate from database migration. For example, XML
migration if your XML format is changing between releases.
3.8 Documentation Considerations
Describe which documents will need to be added or updated due to this feature. Some examples include new online
help for UI changes, Reference Manual update due to DB changes, B&B update because new feature is being added,
Admin Guide update due to new batch process, Programmer’s Guide update because a new API is added, etc.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 9 of 12
4 Unit Testing
This section documents the unit testing methodology that will be used to test this feature.
Describe the overall approach that will be taken to perform the unit testing, e.g., automated test drivers, running the
code through a debugger, adding trace statements that run in debug mode, etc.
4.1 Test Guidelines
Document information that you feel is particularly relevant to the test team. This could include such items as tips for
creating test data, regression areas that need attention, automated test cases that can be augmented by your own unit
test cases, complex code that need attention, problematic areas that need attention , etc.
4.2 Test Cases
This section documents the test cases.
4.3 Test Results
This section documents the test results.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 10 of 12
DOCUMENT CONTROL
Change History
Content changes to this document from the previous to the current level are indicated by revision bars (|) unless a
complete rewrite is indicated.
Table 2 – Implementation Specification Document Change Log
Version/Date Approved By Change Description and Explanation D - Draft
A - For Review/
Approval
R - Re-
Approval, Plan
of Record
Change
Mm/dd/yy Name text D/A/R
Note: If this document has been inspected, please indicate the inspection date that each version is based on in the
“Change Description and Explanation” area. Entries in this log must be maintained for at least 3 years.
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 11 of 12
DOCUMENT APPROVAL
Approvers List
The individuals listed in this section constitute the approvers list for the Integration Test Plan document. Formal
approval must be received from all approvers prior to the initiation of the next steps in the process.
TITLE NAME
Project Manager name
Development Manager name
Reviewers List
The individuals listed in this section constitute the reviewers list for the Master Test Plan document. Formal
approval is not required from the reviewers, however, it is desirable to have all reviewers review and comment on the
document. Reviewers may choose to concentrate on reviewing only those sections that are in their area of
responsibility, rather than the entire document.
TITLE NAME
Solutions Manager name
Project Manager name
Test Manager name
Test Engineer name
Development Manager name
Technical Writer name
Client Support Analyst name
Internationalization Lead name
DBA name
Developer name
Developer name
END OF DOCUMENT
3399521f-c77b-4f38-96a1-a2f3faf96e0f.doc Page 12 of 12
