Article thumbnail

Documentation for software maintenance and there documentation of existing systems

By Nigel Thomas Fletton


The importance of software documentation in maintenance work is widely acknowledged by those involved in the work. However, many new software projects axe still being produced with documentation that is inadequate for efficient support of the product following development. When a product enters the maintenance phase of its life-cycle, the need for quality documentation increases dramatically as it is common for the maintenance team to be composed of personnel who were not involved in the products development. This thesis surveys the tools available for supporting the production of software documentation and then proposes a tool, based on hypertext technology, that will enable maintenance programmers to efficiently create documentation about systems they are working on, where the existing documentation is unsatisfactory

Year: 1988
OAI identifier:
Provided by: Durham e-Theses

Suggested articles


  1. A docimaentation tools to visualize program maintainability.
  2. (1987). A documentation method b£ised on crossreferencing.
  3. (1988). A general purpose hypertext abstract machine. doi
  4. (1988). A hypertext system to manage software life cycle documents. doi
  5. (1987). A survey of hypertext. doi
  6. (1986). A Taste of Smalltalk.
  7. (1982). A theoretical analysis of the role of documentation in the comprehension of computer programs. doi
  8. (1986). Advances in software inspections. doi
  9. (1983). An introduction and handbook for the standard syntactic metcilamguage.
  10. (1945). As we may think. Atlantic Monthly, doi
  11. (1977). automated data systems documentation standards.
  12. (1987). Automating Code and Documentation Management.
  13. (1987). Contexts — a partitioning concept for hypertext. doi
  14. (1988). Converting help systems to hypertext. doi
  15. (1986). Delocalized plans and prograim comprehension. doi
  16. Design and code inspections to reduce errors in program development. doi
  17. (1985). Document Databases. doi
  18. (1987). Document examiner: Delivery interface for hypertext documents. doi
  19. (1976). Federal Information Processing Standards Publication 38. Guidelines for documentation of computer programs and automated
  20. (1988). Fortune's functional definition.
  21. (1987). Guide User's Manual,
  22. (1986). Guidlines for the documentation of digital computer programs.
  23. (1971). Information distribution aspects of design methodology.
  24. (1981). Institution, 2 park St., London WIA 2BS. Method of Defining Syntactic Metalanguage,
  25. (1986). Interactive documentation. doi
  26. (1988). Intermedia: The concept and construction of a seamless information environment. doi
  27. (1988). KMS: a distributed hypermedia system for managing knowledge in organizations. doi
  28. (1987). Madntenance and reverse engineering: Low-level design documents production and improvement.
  29. (1981). Modular documentation: A softwjire development tool. doi
  30. (1986). NEPTUNE: a hypertext system for cad applications. doi
  31. (1985). Reading and writing the electronic book. doi
  32. (1988). Redocimienting software systems u^ing hypertext technology. doi
  33. (1986). SODOS: a softwaire documentation support environment—its definition. doi
  34. (1986). SODOS: a software docimientation support environment—its use. doi
  35. (1986). SOFTLIB—a documentation management system. doi
  36. (1973). Software and its impact: A quantative assessment.
  37. (1982). Software Configuration Management.
  38. (1988). Software engineer's task analysis.
  39. (1986). Software maintenaince — an overview. Rll Divisional Memoramdum Rll/86/013, British Telecom Research Laboratories,
  40. (1985). Software maintenance: A different view. doi
  41. (1983). Software Maintenance: The problem and Its Solutions. Prentice-Hall,
  42. (1984). Software renewal: A case study. doi
  43. (1983). Software test documentation.
  44. (1987). Some psychologiccd evidence on how people debug computer progr£ims.
  45. (1981). Static analysis of commercial programs with the SOFTDOC system.
  46. (1986). SunView System Programmer's Guide,
  47. (1988). Supporting docimient development with concordia. doi
  48. (1986). The c information abstractor.
  49. (1987). The Complete HyperCard Handbook.
  50. (1975). The Mythical Man-Month. doi
  51. (1983). The software improvement process—its phases and tasks.
  52. (1987). The state of softwaire maintenance.
  53. (1986). The X window system. doi
  54. (1987). Turning ideas into products: The guide system doi
  55. (1983). Understanding and documenting software.

To submit an update or takedown request for this paper, please submit an Update/Correction/Removal Request.