ABSTRACT
Good documentation is crucial for the success of frameworks. In this research, a new documenting approach is proposed combining existing document styles in a kind of “minimalist” framework manual with a special emphasis on framework understandability and usability, rather than on describing framework design. Benefits and drawbacks are evaluated from frameworks of different domains and complexity.
- 1.Butler, G., D~nomm~, P. Documenting frameworks. In Building Application Frameworks: Object-Oriented Foundations of Framework Design (New York, 1999), pp. 495-504. John Wiley and Sons. Google Scholar
- 2.Carroll, J. M. The Nurnberg Funnel: Designing Minimalist Instruction for Practical Computer Skill, MIT Press, 1990. Google ScholarDigital Library
- 3.Ian Chai, Ralph Johnson. Pedagogical Framework Documentation: How to Document Object-oriented Frameworks - An Empirical Study. Dissertation, University of Urbana-Champaign, 1999. Google ScholarDigital Library
- 4.Friendly, L. The Design of Distributed Hyperlinked Programming Documentation, 1995, Presented at the International Workshop on Hypermedia Design 95.Google Scholar
- 5.Ramsey N., Literate Programming Simplified. IEEE Software, September, 1994. Google ScholarDigital Library
- 6.Rosson, M. B., Carroll, J. M., Bellamy, R. K. E. (1990) "SmallTalk Scaffolding: A Case Study of Minimalist Instruction". In Proceedings of CHI '90, pp. 423-429. Google ScholarDigital Library
- 7.Taligent Inc. (1994). Building Object-Oriented Frameworks. Taligent Inc.Google Scholar
Index Terms
- A minimalist approach to framework documentation
Recommendations
Automating testing by reverse engineering of software documentation
WCRE '95: Proceedings of the Second Working Conference on Reverse EngineeringReverse engineering of software documentation can play an important role in automating software testing. Since testers often compare the operation of a software system to the expected behavior as described in a document, information extraction from ...
API documentation and software community values: a survey of open-source API documentation
SIGDOC '13: Proceedings of the 31st ACM international conference on Design of communicationStudies of what software developers need from API documentation have reported consistent findings over the years; however, these studies all used similar methods--usually a form of observation or survey. Our study looks at API documentation as artifacts ...
On mining crowd-based speech documentation
MSR '16: Proceedings of the 13th International Conference on Mining Software RepositoriesDespite the globalization of software development, relevant documentation of a project, such as requirements and design documents, often still is missing, incomplete or outdated. However, parts of that documentation can be found outside the project, ...
Comments