Estimating understandability of software documents
Author:
Open Access
- 1 July 1996
- journal article
- Published by Association for Computing Machinery (ACM) in ACM SIGSOFT Software Engineering Notes
- Vol. 21 (4) , 81-92
Abstract
Software developers and maintainers need to read and understand source programs and other kinds of software documents in their work. Understandability of software documents is thus important. This paper introduces a method for estimating the understandability of software documents. The method is based on a language theory according to which every software document is considered to contain a language of its own, which is a set of symbols. The understandability of documents written according to different documentation practices can be compared using the rules of the language theory. The method and the language theory are presented by using source programs with different naming styles as example documents. The method can, at least theoretically, be applied to any kind of document. It can also be used to explain the benefits of some well-known software design methods.Keywords
This publication has 7 references indexed in Scilit:
- The effects of naming style and expertise on program comprehensionInternational Journal of Human-Computer Studies, 1994
- How effective are software engineering methods?Journal of Systems and Software, 1993
- Document classification for software quality systemsACM SIGSOFT Software Engineering Notes, 1992
- A guide to natural namingACM SIGPLAN Notices, 1990
- Acronyms observedIEEE Transactions on Professional Communication, 1989
- A field study of the software design process for large systemsCommunications of the ACM, 1988
- On choosing identifiersACM SIGPLAN Notices, 1982