Enforcing documentation discipline in an organization




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

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

  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.

 



Frequently Asked Questions

+
Ans: System documentation: Detailed information about a system’s design specifications, its internal workings, and its functionality. Internal documentation: System documentation that is part of the program source code or is generated at compile time. view more..
+
Ans: Systems Planning and Selection : The first phase of the SDLC, in which an organization’s total information system needs are analyzed and arranged, and in which a potential information systems project is identified.Systems Analysis : Phase of the SDLC in which the current system is studied and alternative replacement systems are proposed. view more..
+
Ans: Systems development methodology: A standard process followed in an organization to conduct all the steps necessary to analyze,design, implement, and maintaininformation systems. | Systems development life cycle (SDLC): The series of steps used to mark the phases of development for an information system. view more..
+
Ans: 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”. Phase should not be considered complete until documentation is done. Coding should not be considered done unless its has required comment lines. view more..
+
Ans: There are various techniques to gather data and facts of system. some of them re as follows : Record view and Background reading Interviews  Questionnaires Group communication Presentation Site visiting Observation view more..
+
Ans: Feasibility studies are almost always conducted where large sums are at stake. Also called feasibility analysis. A feasibility study is conducted in order to determine the success and minimize the risks related to the project. When it becomes certain that the specific project could be carried out profitably view more..
+
Ans: It is a final report of the feasibility study about the findings and conclusion of the study. it should be possible to review report and take decision on the project based on it view more..
+
Ans: System selection means selecting the various hardware, software, and services that are needed for implanting the system. Before the system selection can be done, it is necessary to know the capabilities of required proposed system view more..
+
Ans: Costs fall into two categories. There are cost associated with developing the systems and there are costs associated with a operating a system. view more..
+
Ans: Quantitative measure of degree to which a system, component or process possesses a given attribute For ex. No. of errors found per person hours expended Cost and Effort Estimation : Boehm’s COCOMO model, Putnam’s SLIM Model & Albrecht’s function model. view more..
+
Ans: There are three such classes: Process are collection of software related activities. Products are any artifacts, deliverables or documents that result from a process activity view more..
+
Ans: A direct measure is obtained by applying measurement rules directly to the phenomenon of interest.For example, by using the specified counting rules, a software program’s “Line of Code” can be measured directly. and sofware reliabity is .... view more..
+
Ans: What Is Information Systems Analysis and Design? Information systems analysis and design is a method used by companies ranging from IBM to PepsiCo to Sony to create and maintain information systems that perform basic business functions such as keeping track of customer names and addresses, processing orders, and paying employees. The main goal of systems analysis and design is to improve organizational systems, typically through applying software that can help employees accomplish key business tasks more easily and efficiently. As a systems analyst, you will be at the center of developing this software. view more..
+
Ans: concurrency of components, lack of a global clock and independent failures of components and the ability to work well when the load or the number of users increases – failure handling, concurrency of components, transparency and providing quality of service view more..
+
Ans: the wide range of applications in use today, from relatively localized systems (as found, for example, in a car or aircraft) to globalscale systems involving millions of nodes, from data-centric services to processorintensive tasks, from systems built from very small and relatively primitive sensors to those incorporating powerful computational elements, from embedded systems to ones that support a sophisticated interactive user experience, and so on. view more..
+
Ans: The task of a web search engine is to index the entire contents of the World Wide Web, encompassing a wide range of information styles including web pages, multimedia sources and (scanned) books view more..
+
Ans: The growth of the World Wide Web as a repository of information and knowledge; the development of web search engines such as Google and Yahoo to search this vast repository view more..
+
Ans: The engineering of MMOGs represents a major challenge for distributed systems technologies, particularly because of the need for fast response times to preserve the user experience of the game. view more..



Recommended Posts:


Rating - 3/5
504 views

Advertisements