Enforcing documentation discipline in an organization



Rating - 3/5
465 views

Documentation discipline should be enforced in an organization. All employees should have a habit of making proper documentation of/in their work. 

These Topics Are Also In Your Syllabus
1 Concurrency link
2 Transparency link
You May Find Something Very Interesting Here. link
3 Quality of service link
4 Case study: The World Wide Web link
5 Summary link

Lets say, How documentation required in Software developer’s work :

These Topics Are Also In Your Syllabus
1 Direct and Indirect Measures, Reliability link
2 What Is Information Systems Analysis and Design? link
You May Find Something Very Interesting Here. link
3 CHARACTERIZATION OF DISTRIBUTED SYSTEMS link
4 Introduction link
5 Types Of Systems link
  1. First, Developer must have a proper SRS( software requirement specification) before writing to code.
  2. Developer should write proper comments in his code because it will be easier for the other developer(who will work next on the same code) to understand the existing code in a better way.  
  3. It is developers responsibility to properly document their software’s working means, how the software’s functionality works, prerequisite for the software etc.

Documentation management is necessary for organization because :

  1. Increase Collaboration & Communication
  2. Reliable Document Version Control
  3. Increase Time-Cost Savings
  4. Eases Accessibility
  5. Increase Productivity

So now the question is, How can we enforce Documentation discipline in an organization ? 

  1. organization should consider it as integral part of work.
  2. Proper resources should be made available to build document management system whether its human resource or technical resource
  3. procedures should be set up to create or review documentation
  4. Management should not be lenient on part of documentation, management should never say like  “ as time running short , so just create the system and make the documentation later”.
  5. Phase should not be considered complete until documentation is done.
  6. Coding should not be considered done unless its has required comment lines.

 

These Topics Are Also In Your Syllabus
1 Case study: The World Wide Web link
2 Summary link
You May Find Something Very Interesting Here. link
3 SYSTEM MODELS link
4 Introduction link
5 Physical models link

Rating - 3/5
495 views

Advertisements
Rating - 3/5