How to Write Software Design Descriptions
I N T R O D U C T I O N
The task of developing comprehensive Software Design Descriptions (SDDs) is greatly assisted by this document. Written for project personnel, it is basically a plain-English, simplified version of the IEEE Std 1016 Recommended Practice for Software Design Descriptions. While it infringes no copyright, it still embodies the essential detail of IEEE 1016.
It describes the:
Software development context in which an SDD should be created, Minimum requirements for SDD format and content and, Qualities of a good SDD. Who is this document for? The SDD is created by the System Architect or designer and is the major deliverable from the detailed design process.
What are the Prerequisites? The prerequisite document required for an SDD varies according to the size and complexity of the software product to be developed. For large systems the prerequisite is the System Architecture Specification. In this context the SDD represents a further refinement of the design entities described in the SAS. An SDD may provide descriptions of one or more design entities. For small systems, the SDD prerequisite is a Software Requirements Specification. In this context it is the single source of design solutions to problems stated in the SRS.
Who uses the SDD? The SDD is the primary reference for code development. As such, it must contain all the information required by a programmer to write code.
Contribution to IS Quality A structured and comprehensive approach to software design is known to be a major factor contributing to Information Systems Quality. Adequate design is however often not performed, contributing to a higher number of software defects which impact the real and perceived quality of the software, as well as leading to time and expense being spent on rework and higher maintenance costs.
How to Write Software Design Descriptions is a plain-English, procedural guide to developing high quality SDDs that are both systematic and comprehensive. It contains detailed instructions and templates on the following test documentation.
V I E W - S A M P L E S
Click here to see a sample of the SDD document, complete with a list of the topics covered.
Note formatting may be affected in conversion from Word to HTML.
D O W N L O A D - F R E E - U S E F U L - S A M P L E S
Two brief (~10 pages each) how to guides can be downloaded for free. They are zip files containing rtf & pdf copies of the documents.
They are useful and relevant to any software development project and are intended to give prospective buyers of the full featured range of TCS how to guides an indication of their quality and usefulness.
Click here to download How to Perform Risk Management (.docx format).
Click here to download How to Perform Project Estimates (.docx format).
A B O U T T H E A U T H O R
How to Write Software Test Documentation was written by David Tuffley, who combines a successful career as a technical communication and quality management consultant with academic involvement at the School of ICT, at Griffith University, Australia, where he is doing postgraduate research in IS Quality.
See Client list.
O R D E R Y O U R C O P Y N O W
This guide, proven over the past five years at large commercial and public sector sites, could save you thousands of dollars in consultancy fees. Or put it another way, you could not buy even an hour of a good consultant's time for the price of this valuable How To guide. Yet consultants routinely spend weeks or months implementing procedures similar to those contained in this guide.
Ordering your copy of this excellent How To guide for only US$24.95 is easy. Buy It
Transaction Record. Your credit card transaction will be processed using the latest secure processes by CCNow (TCS's authorized online retailer). Your credit card transaction statement will show CCNow.
Delivery Information. You will receive a download link by email soon after you place the order. The download contains the deliverables in MS Word (.docx) and PDF. The documents are your master copy.
Transaction Record. Your credit card transaction will be processed using the latest secure processes by CCNow (TCS's authorized online retailer). Your credit card transaction statement will show CCNow.
O T H E R T C S P U B L I C A T I O N S
Client list Complete Library (all of the below + 19 extra) 
User Manuals Software Requirements Specifications Capture IS User Requirements Software Test Documentation Software Design Descriptions Configuration Management Plans Version & File Software Development Documentation Software Project Agreements Software Project Plans Software Quality Management Plans Software Project Review & Audits Software Project Terms of Reference Perform Software Project Metrics Initiate Software Projects Software project procurement & handling client supplied materials R E T U R N T O T C S H O M E P A G E
Site design by David Tuffley.