Service > Software Development >

Documentation Process


 Document  Description

Project Assignment Doc / Vision Document

 - This will be basis of making SRS. This Document    shall contain Project Name, Project Abbreviation,    References, all architectural issues (like separation    of different logic, multilingual issues), instructions    whether to make certain libraries or reuse already    existing or downloadable libraries or third party    tools, Data Sizing, broad functionalities, type of    users, compatibility issues (OS, DB, Browsers),    Instructions for Testing / Test Data, anything else    which is to be kept in mind while developing the    technical document.

 - If working on the old project, bug list or    enhancement list will be treated as this document.


SRS

 - This document should be understandable & helpful    for programmers. This Document should contain    user cases, detailed Functionalities with validations,    limitation, data flow diagrams, suggested    screenshots, Description of Layers, Table    Descriptions, ER- Diagram, Naming conventions to    be followed in files/dlls, Coding standards to be    followed etc.

Test Cases

 - This document should cover the system    requirements, negative test cases, positive testing    plan.

Installation Document

 - This document should describe the installation    routine which can be used by Client’s administrator    to install the product on their server

Internal Release Note

 - Will be signed by the programmer (for one person    project) and by project lead (for two or more    involved person). Before releasing Internal Release    Note, all project documents must be updated, all    files including Database scripts are put in versioning    control system e.g. VSS and test environment for    testing is created.

External Release Note

 - It is a release note for the client. A copy of this    goes to the client. All points related to Internal    Release Note should be followed.

Project Plan

 - This is a project status plan which is regularly sent    to the client to that project status can be monitored.

Non-compliance Document

 - If guidelines of vision / SRS have not been    followed, they must be mentioned in the non-   compliance document



All Documents have pre-defined templates and follow proper naming conventions and versioning







Service l Products l Resources l Career l Company l
Copyright © 2006 Softbrains Infotech Limited