How to Write, Version & File Software Development Documentation

I N T R O D U C T I O N

How to Write, Version & File Software Development Documentation is a combined How To guide, incorporating three TCS standards; Document Production, Version Control and Filing.

The document production standard defines the minimum requirements for the content and layout of software project documentation. A uniform 'look and feel' to project documents which is based on sound formatting guidelines leads to greater ease of use and less error and a professional image.

The version and status identification standard defines the minimum information needed to maintain control over deliverables as they progress through the project lifecycle. By tagging a document and software deliverable with a version number, we are able to clearly differentiate between the current version and all previous versions. By providing the status, we are able to indicate the state of the deliverable to a more general audience. This standard therefore defines a uniform numbering and status convention applying to all versions of all deliverables. The benefit of using this standard for controlling version numbering and status is that we can achieve a high degree of consistency within printed materials and program files. A second benefit is the quick recognition of whether the material or file is an approved version or not.

The project document filing standard specifies the mechanism by which project documentation is identified and stored so as to make it accessible to all those who need to have access. In particular this standard provides a document register for all project documents, and a document identification and filing system which ensures that all documents and correspondence produced or collected during the life of a project.

S C O P E

The document production standard applies to all project documentation. That is defined as any material generated internally during any stage of a project. It includes the following:

The version and status identification standard applies to the following:

The project document filing standard applies to all project documentation and correspondence generated during the life of a project.

O B J E C T I V E S

document production

The objectives of the version and status identification standard are the following:

The objectives of the project document filing standard are the following:

Contribution to IS Quality. Consistant, accurate project documentation is known to be a major factor contributing to Information Systems Quality. Document production, version control and filing is 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, Version & File Software Development Documentation is a plain-English, procedural guide to developing first rate project documentation. It contains detailed instructions and templates.

V I E W - S A M P L E S

Click here to see the contents list.

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, Version & File Software Development Documentation was written by David Tuffley, who combines a successful career as a 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.

How to Use the Documents. Save the master as a working document. Read the reference text that details what needs to be written, and to what level of detail. Then write what needs to be written, and delete the reference text, leaving the completed document. The structure is embodied in the template. Documents can be converted to HTML for intranet/internet delivery if desired, using your wordprocessor's inherent HTML conversion capabilities, or by using proprietary conversion software that builds contents hierarchies that greatly facilitates navigation. Contact TCS for more information.

View Shopping Cart (what you've already selected) / Checkout (pay for item(s) in shopping cart)

O T H E R T C S P U B L I C A T I O N S

Client list

Complete Library