Cited By
View all- Zhi JGarousi-Yusifoğlu VSun BGarousi GShahnewaz SRuhe G(2015)Cost, benefits and quality of software development documentationJournal of Systems and Software10.1016/j.jss.2014.09.04299:C(175-198)Online publication date: 1-Jan-2015
The documentation of quality engineering: applying use cases to drive change in software engineering models
Pages 4 - 13
Abstract
This paper examines how documentation is used to create "quality" engineering processes in software development, focusing on recent industry trends of adopting use case driven software engineering models, to investigate a phenomenon that in this paper I call "genre dumping." The paper aims to address questions about how software development methods change under a use-case driven model. For example, is it really that easy to adopt the use case methodology? The paper draws from a 24-month case study of a small cross-disciplinary team of software designers, developers, testers, and managers who are helping build a large in-house application for a multinational financial services corporation called "Financial Capital" (pseudonym). This project was selected for study because a use case driven model was being applied to explicitly change software engineering practices: use cases were newly adopted and thus unfamiliar to those involved in the software development project.
Presented are selected results of qualitative and quantitative analyses of textual and interview data. The findings are interpreted using rhetorical genre theory, which features a large and growing body of workplace research about the ways documents enable (and constrain) people to get work done. The results show that textual features of the documents of the older design methods persist in the newly adopted use cases and that readers' approaches to text-related meaning making also persist, indicating generic recurrence. The findings also show that conflict occurs at the same sites where recurrence occurs. The paper concludes with discussions of implications for technical communicators and genre theorists interested in technical communication.
References
[1]
Jacobson, I., Booch, G., and Rumbaugh, J. The Unified Software Development Process. Addison-Wesley, Boston, MA, 1999.
[2]
Schryer, C. Records as Genre. Written Communication, 10, 2, (1993), 200--234.
[3]
Miller, C. Genre as Social Action. Quarterly Journal of Speech, 70, 2 (1984), 151--67.
[4]
Campbell, K. K., and K. H. Jamieson. Form and Genre in Rhetorical Criticism: An Introduction. Form and Genre: Shaping Rhetorical Action. Falls Church, VA, The Speech Communication Association, 1978.
[5]
Swales, J. Genre Analysis: English in Academic and Research Settings, Cambridge, Cambridge UP, 1990.
[6]
Spinuzzi C., and M. Zachry. Genre Ecologies: An Open-System Approach to Understanding and Constructing Documentation. ACM Journal of Comp. Doc., 24,3 (2000), 169--181.
[7]
Ornatowski, C. M. 2+2=5 If 2 Is Large Enough: Rhetorical Spaces of Technology Development in Aerospace Engine Testing. Journal of Bus. and Tech. Comm., 12, 3, (1998), 316--342.
[8]
Winsor, D. A. Rhetorical Practices in Technical Work. Journal of Bus. and Tech. Comm., 12, 3 (1998), 343--370.
[9]
Jacobson, I. Object-Oriented Development in an Industrial Environment. In Proceedings of the SIGPLAN Conference on Object-Oriented Programming Systems, Languages, and Applications (OOPSLA '87). ACM Press, NY 1987, 183--91.
[10]
Jacobson, I. Résumé. Sept. 2003. Available online at http://www.ivarjacobson.com/files/CV%202003-09-17.doc.
[11]
Jacobson, I. Use Cases - Yesterday, Today, and Tomorrow. The Rational Edge: e-zine for the Rational Community. March 2003.
[12]
Kulak, D., and Guiney, E. Use Cases: Requirements in Context, Reading, MA, Addison-Wesley, 2000.
[13]
Larman, C. Applying UML and Patterns: An Introduction to Object-Oriented Analysis and Design and the Unified Process. Upper Saddle River, NJ, Prentice Hall, 2002.
[14]
Larman, C., and Basili, V. R. Iterative and Incremental Development: A Brief History. Computer, 36,6 (2003), 47--56.
[15]
Cockburn, A. Writing Effective Use Cases, Boston, Addison-Wesley, 2001.
[16]
Beaumont, R. Information Systems (IS) Development Methods. 6 secs. Sept. 1999. Available online at http://www.robinbt2.free-online.co.uk/virtualclassroom/chap12/s3/des1.htm.
[17]
Author unknown. Rational Unified Process: Best Practices for Software Development Teams. White paper. IBM developerWorks: Rational. 16 June 2003. Available online at http://www106.ibm.com/developerworks/rational/library/content/03July/1000/1251/1251_bestpractices_ TP026B.pdf
[18]
Jacobson, I., and Lindström, F. Re-engineering of old systems to an object-oriented architecture. In Proceedings of the SIGPLAN Conference on Object-Oriented Programming Systems, Languages, and Applications (OOPSLA '91). ACM Press, New York, NY, 1991. 340--350.
[19]
Oberg, R., Probasco, L., and Ericsson, M. Applying Requirements Management with Use Cases. Rational White Paper. Cupertino, CA: Rational Software Corporation, 2000.
[20]
Juric, R. and Kuljis, J. Engineering Requirements through Use Cases in Complex Business Environment. Requirements Engineering, 4 (1999), 65--76.
[21]
Cockburn, A. Structuring Use Cases with Goals. 13 secs. February 2000. Originally published in two parts: "Goals and Use Cases." Journal of OO Prog., 10, 5, (1997), 35-40. "Using Goal-Based Use Cases." Journal of OO Prog., 10, 7, (1997), 56--62. Available online at http://alistair.cockburn.us/crystal/articles/sucwg/structuringucswithgoals.htm.
[22]
Adolph, S., and Bramble, P. Patterns for Effective Use Cases. Boston, MA, Addison-Wesley, 2003.
[23]
Armour, F., and Miller, G. Advanced Use Case Modeling: Software Systems, Boston, Addison-Wesley, 2001.
[24]
Bittner, K., and Spence, I. Managing Iterative Development with Use Cases. 10 secs. March 2003. The Rational Edge: e-zine for the Rational Community. Available online at http://www-106.ibm.com/developerworks/rational/library/5093.html.
[25]
Schneider, G., and Winters, J. P. Applying Use Cases, Boston, Addison-Wesley, 2001.
[26]
Geisler, C. Analyzing Streams of Language: Twelve Steps to the Systematic Coding of Text, Talk, and Other Verbal Data, New York, Pearson Longman, 2004.
[27]
Odell, L., Goswami, D., and Herrington, A. The Discourse-Based Interview: A Procedure for Exploring the Tacit Knowledge of Writers in Nonacademic Settings. Research on Writing: Principles and Methods, NY, Longman, 1983, 221--236.
[28]
Schriver, K. A. Evaluating Text Quality: The Continuum from Text-Focused to Reader-Focused Methods. IEEE Transactions on Prof. Comm., 32,4 (1989), 238--255.
[29]
Bhatia, V. Analysing Genre: Language Use in Professional Settings, London, Longman, 1993.
[30]
Landis, J.R., and Koch, G. G. The Measurement of Observer Agreement for Categorical Data. Biometrics, 33,1 (1977), 159--174.
[31]
Yin, R. K. Case Study Research: Design and Methods, Thousand Oaks, CA, Sage Publications, Inc., 2002.
[32]
Cockburn, A., and M. Fowler. Question Time! About Use Cases. In Proceedings of the SIGPLAN Conf. on OO Programming Systems, Languages, and Applications (OOPSLA '98). New York, NY: ACM Press, 1998. 226--229.
[33]
Bazerman, C. Singular Utterances: Realizing Local Activities through Typified Forms in Typified Circumstances. Analysing Professional Genres. Amsterdam, John Benjamins Publishing Co., 2000, 25--40.
[34]
Paré, A. Genre and Identity: Individuals, Institutions, and Ideology. The Rhetoric and Ideology of Genre. Cresskill, NJ, Hampton Press, 2002, 57--72.
Index Terms
- The documentation of quality engineering: applying use cases to drive change in software engineering models
Recommendations
Examining the use case as genre in software development and documentation
SIGDOC '03: Proceedings of the 21st annual international conference on DocumentationThe practice of outsourcing among organizations frequently involves external companies or consultants introducing texts (or in rhetorical genre theory terms, genres) as means of transforming work practices in the company who sought expert help from the ...
Agile quality requirements engineering challenges: first results from a case study
ESEM '17: Proceedings of the 11th ACM/IEEE International Symposium on Empirical Software Engineering and MeasurementAgile software development methods have become increasingly popular in the last years. Despite their popularity, they have been criticized for focusing on delivering functional requirements and neglecting the quality requirements. Several studies have ...
Visual SDLC: improving requirements engineering for object-oriented systems
OOPSLA '03: Companion of the 18th annual ACM SIGPLAN conference on Object-oriented programming, systems, languages, and applicationsIn theory, requirements engineering solves many of software engineering's fundamental problems. The stakeholders know what the developers are building, why they are building it, when they are building it, and even to some degree, how they are building ...
Comments
Please enable JavaScript to view thecomments powered by Disqus.Information & Contributors
Information
Published In
October 2004
160 pages
Copyright © 2004 ACM.
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]
Sponsors
Publisher
Association for Computing Machinery
New York, NY, United States
Publication History
Published: 10 October 2004
Check for updates
Author Tags
Qualifiers
- Article
Conference
SIGDOC04: ACM 22nd Annual International Conference on Documentation 2004
October 10 - 13, 2004
Tennessee, Memphis, USA
Acceptance Rates
Overall Acceptance Rate 355 of 582 submissions, 61%
Contributors
Other Metrics
Bibliometrics & Citations
Bibliometrics
Article Metrics
- View Citations1Total Citations
- 965Total Downloads
- Downloads (Last 12 months)2
- Downloads (Last 6 weeks)0
Reflects downloads up to 01 Jan 2025
Other Metrics
Citations
Cited By
View all- Zhi JGarousi-Yusifoğlu VSun BGarousi GShahnewaz SRuhe G(2015)Cost, benefits and quality of software development documentationJournal of Systems and Software10.1016/j.jss.2014.09.04299:C(175-198)Online publication date: 1-Jan-2015
View Options
Login options
Check if you have access through your login credentials or your institution to get full access on this article.
Sign in