Open Access Open Access  Restricted Access Subscription Access

Software Documentation Management Issues and Practices: A Survey


Affiliations
1 School of Computer Science and Engineering, VIT University, Near Katpadi Road, Vellore – 632014, Tamilnadu, India
 

Background/Objectives: Software Documentation plays a significant role in any project. This paper is mainly focused on summarizing the various problems with documentation and the practices proposed to address them. Findings: The analysis establishes the fact that documentation needs are specific for each project. The documentation management issues relate to either neglecting or overdoing documentation. Application/Improvements: A study of all the issues and practices for documentation management revealed that documentation processes should be tailor made for every project according to the various factors that determine the documentation needs for a project. Implementation of documentation practices should be project specific rather than organization specific.

Keywords

Artifacts, Maintenance, Software Documentation, Software Engineering.
User

Abstract Views: 234

PDF Views: 0




  • Software Documentation Management Issues and Practices: A Survey

Abstract Views: 234  |  PDF Views: 0

Authors

C. J. Satish
School of Computer Science and Engineering, VIT University, Near Katpadi Road, Vellore – 632014, Tamilnadu, India
M. Anand
School of Computer Science and Engineering, VIT University, Near Katpadi Road, Vellore – 632014, Tamilnadu, India

Abstract


Background/Objectives: Software Documentation plays a significant role in any project. This paper is mainly focused on summarizing the various problems with documentation and the practices proposed to address them. Findings: The analysis establishes the fact that documentation needs are specific for each project. The documentation management issues relate to either neglecting or overdoing documentation. Application/Improvements: A study of all the issues and practices for documentation management revealed that documentation processes should be tailor made for every project according to the various factors that determine the documentation needs for a project. Implementation of documentation practices should be project specific rather than organization specific.

Keywords


Artifacts, Maintenance, Software Documentation, Software Engineering.



DOI: https://doi.org/10.17485/ijst%2F2016%2Fv9i20%2F133238