DocIT
YOUR DOCUMENT PARTNER!
DocIT Template Set
Overview
Software is not just pieces of code sewn together. It is a carefully crafted artifact developed to meet the needs either of an individual or of an enterprise. No software is an end in itself. It evolves with the needs of the user. Modifications and additions to a running software application are inevitable. If the application is to be understood and maintained, it must be well documented. Documentation, therefore, is vital and becomes part and parcel of a software application.
Most software in use today has very poor documentation to support it, if at all. Vitalsoft aims to fill this gap with its expertise in generating the necessary documentation in the form of software artifacts.
Before implementation
From requirements to design
Requirements gathering begins with a vision statement, a free-flowing text that envisions the would-be software to meet customer needs. A formal specification document emerges from it, which will then guide the entire documentation that comes after it.
After implementation
From coding through deployment to manuals
From the use cases prepared at the requirements stage, the test cases emerge, and finally the developer and user manuals follow, with deployment notes.
Use Cases
A graphical or textual matter to underscore system user's perspective
Requirements Document
A formal specification document enumerating the requirements
Detail design
Design diagrams and other UML artifacts
Change Management
A formal document to track changes in requirement specifications
Documenting Code
In-line documentation to describe operations and design decisions
Test Cases
With specific reference to requirements providing a traceability matrix
Deployment and Release notes
Deployment notes for each release and iteration
Manuals
Documenting developer API and generating user guide