Documentation of a Project
In a fast-paced world as the world of the software industry, it is
extremely important to document software. Thus, some artifacts in the form
of documentation are usually derived from the software itself.
In the following table you will find the main areas of software
documentation and an explanation for each of them:
| Short Description | Description |
| SHLA |
The "System High Level Approach" describes the coarse business requirements of a project, i.e. the basic requirements of the customer. This document also emphasizes technical details like Skalability, Reusability, and Maintainability. Coarse information defining data exchange between systems, Data- bases and users are also discussed in this document. This document is not trying to give detailed information about the Overall Design of a System but rather describes the frame of a projects and its requirements. The Customer and Sybec Technologies should agree on a sign-off of this document, which eliminates misunderstandings. |
| ORS |
The "Operational Requirements Statement" describes infrastructural pre-requisites of a project. Things like bandwidth (network), Data-Volume (database), redundance of all systems, as well as estimates of cost of ownership (COO) of possibly not yet existing but required infrastructure. |
| UHLA |
The "SHLA" and the "ORS" are finally melted into one single Analysis-Document, which covers economical as well as technical requirements and contains the actual project request and its definition. This document is signed off by a representative of Sybec Technologies and the Customer, in case a project contract was already ordered. Please regard that this document embodies the Analysis phase of the project's life-cycle and also contains a feasability study. Changes to this document require a so-called "SCR" (Scope Change Request), i.e. a request to change the requirements of a project. |
| DS |
The "Design Statement" defines the Design of the System/Application, which was requested by the customer. Although this document should only aid employees and co-workers in developing a system/application, the customer can undoubtedly obtain a copy of the design statement. In this document design issues are explained in a detailed fashion. It encapsulates the design of the System/Application. |
| DBS |
The "Database Statement" describes issues, design, and maintainance of the database. This includes a description of the physical as well as logical layout of the database. This document reflects an addition to the Design Statement |
| TestRun |
The "TestRun" is a series of documents, which covers tests of infrastructure, software, as well as user-friendliness of the system. Test-Cases are usually derived from the Use-Cases, which are artifacts of the Analysis phase. This derivation ensures testing all possible scenarios. |
| Security |
The "Security Document" describes the Overall-Security of a system, its physical components (Systems and Databases), Network-Security, Password-Rules, cryptographic Analysis (in case, Cryptography is used), and common security issues. |
| Deployment |
This document describes the Integration/Installation of a system with all embedded components. The purpose of this document is to aid System Administators and Integration Specialists who hadn't had the time to familiarize themselves with the system(s)/application(s), so they can obtain enough information to successfully integrate the same. This document also covers deployment-relevant information about Networking, OS, Databases, pre-requisites (Software), etc. |
* Note: Not all of the above described documents are necessary for every project.
© 2007 Sybec Technologies