Need of Documentation

Need of Documentation

Need of Documentation

Let’s mention some commonplace definitions of documentation,

There is little question that documentation may be a crucial a part of project management. It fulfils the 2 most vital components of a project management system: to confirm that project necessities consummated and to ascertain traceability with relation to what has been done, United Nations agency has done it and once was it done.

Documentation lays grounds for quality, history and traceability for the complete project and separately furthermore. It’s importance comes into existence once there's a modification in team members or a brand new resource is superimposed to the team. Documentation ought to be specified the any new addition to team ought to be able to scan and perceive the project.

Project Management Uses

Project managers shine at creating templates for his or her documents that simple to scan. They employ productive project plans, business cases, demand sheets, and project standing reports to assist them specialise in their core ability of managing the project instead of levelling the unmanageable work.

Every project manager contains a set of templates able to be stuffed as presently because the project necessities are available. Project Management typically follows the subsequent

  1. Initiation: practicableness report and project charter
  2. Planning: demand specs, style document and estimates
  3. Execution: User Stories, take a look at Cases and Traceability Matrix
  4. Control: modification management
  5. Closure: Technical document, purposeful document, relinquishment document and contract closure

Feasibility Report

The purpose of a practicableness report is to validate that the project is worth it. practicableness is verified by 5 primary factors:

  1. Technology and system
  2. Economic, legal
  3. Operational
  4. Schedule.

Project Charter

Project charter conjointly called the project summary statement includes high-level coming up with that lays the muse for the project. It acts as associate anchor that holds the project objective and guides every one within the team through the milestones.

Requirement Specification

It is an entire description of the project that has to be developed. to boot, it includes all specification to be enclosed within the project together with non purposeful necessities.

Design Document

The style document includes all high level and low level design parts. The document is largely an outline of the field ways of the system.

Work Plan/Estimate

A work set up describes phases, activities, and tasks that required to deliver the project with correct timeline furthermore as resource coming up with and milestones that also are enclosed within the work set up. This document accounts for the calculable time, resources it'll want complete the project whereas actual progress is reviewed on a everyday against this document that makes it because the most vital document.

Traceability Matrix

It is a table that traces the necessity to the tests that required to verify that the necessity is consummated. a decent traceability matrix includes each backward and forward traceability which suggests a demand will be derived to a take a look at and a take a look at to a demand.

Change Management Document

The document is employed to capture progress and changes created to a system. It helps in linking unlooked-for adverse effects of a modification.

Test Document

A take a look at document includes take a look at cases and take a look at set up. A action at law absolutely tests a feature or a sub task of a feature. whereas a take a look at set up describes what to check, a action at law describes the way to perform a specific take a look at.

Functional Document

This document defines the internal workings of a system. It doesn't embody the specification of however the system operate are enforced.

Handover Document

The relinquishment document holds an inventory of all the deliverables of the system.

Contract Closure

Contract closure is the method of completion of all tasks and terms that introduce as deliverable and outstanding upon the initial drafting of the contract.

All these documents holds equal significance in a very project management system. Documentation is that the best, and generally the sole means you'll keep a record of the work done, the ways used, the changes that occurred and every one the insufficient specifics a mean human mind is capable of forgetting. Knowing the history of the project is important for this set up of action furthermore as however you proceed within the future.

Here is the Example of Java Doc Documentation:-

    * Base class for activities that wants to use some of the newer platform features on older
    * Android devices. Some of these backported features include:
    * <ul>
    *     <li>Using the action bar, including action item, navigation modes and more with
    *     the {@link #setSupportActionBar(Toolbar)} API.</li>
    *     <li>Built-in shifting between light and dark themes by using the
    *     {@link Theme.AppCompat.DayNight} theme     
    *     and {@link AppCompatDelegate#setDefaultNightMode(int)} API.</li>
    *     <li>Integration with <code>DrawerLayout</code> by using the
    *     {@link #getDrawerToggleDelegate()} API.</li>
    * </ul>
    * <p>Note that every activity that extends this class has to be topic with
    * {@link Theme.AppCompat} or a subject that extends
    * that theme.</p>

    * <div class="special reference">
        * <h3>Developer Guides</h3>
        * <p>For details about how to use the action bar, including how to add action items, navigation
        * modes and more, write the <a href="{@docRoot}guide/topics/ui/actionbar.html">Action
        * Bar</a> API guide.</p>
        * </div>

I Hope you enjoy this blog

Thank You

Want a Team that Delivers Result ? Connect now with us.


Our Offices


F-429, Phase 8B, Industrial Area, SAS Nagar, Punjab 160059

+91 82198-18163


13506 Summerport Village Pky Suite 355 Windermere, FL 34786

+1 (321) 900-0079


15 Meltwater Cres, Brampton L6P3V8

+1 (647) 892-6147