A discourse analysis of software documentation: implications for the profession

N.J. Walters; C.E. Beck

doi:10.1109/47.158981

IEEE Transactions on Professional Communication Jan 1992

A discourse analysis of software documentation: implications for the profession

N.J. Walters ; C.E. Beck University of Colorado Denver

Abstract

To discover the similarities and differences between primary and secondary computer manuals, and to account for the popularity of the secondary texts, two best-selling books for word processing and spreadsheet programs are compared to documentation supplied by the manufacturer. A heuristic for analyzing software documentation based on cognitive and rhetorical principles is developed and applied to the corporate documentation for (WordPerfect 5.0) in contrast to Stewart's Using WordPerfect 5 from Que, and the corporate documentation from 'Lotus 1-2-3' in contrast to Gilbert and Williams's 'The ABC's of 1-2-3 from Sybex.' It is shown that the trade texts from Que and Sybex contain more conceptual background information than the corporate documentation and differ in their rhetorical stance: the writers provide a richer context by giving more examples for applying the software; the writers provide global and structural frameworks; the writers use persuasive marketing techniques to ease the reader's anxieties and remind them of the software's benefits; and the writers identify themselves.< <ETX xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink">></ETX>

Journal: IEEE Transactions on Professional Communication
Published: 1992-01-01
DOI: 10.1109/47.158981
CompPile
Open Access: Closed
Topics: rhetorical criticism discourse analysis digital rhetoric
Export: BibTeX RIS

Citation Context

Cited by in this index (3)

Baker (2020)

Contextual Information in Social How-To Questions That Initiate Documentation

Journal of Business and Technical Communication
Maher (2011)

The Technical Communicator as Evangelist: Toward Critical and Rhetorical Litera…

Journal of Technical Writing and Communication
Johnson-Eilola (1996)

Relocating the Value of Work: Technical Communication in a Post-Industrial Age

Technical Communication Quarterly

References (34) · 2 in this index

(1988)

Effective Documentation What We Have Learned from Research
shriver (1986)

Designing Computer Documentation A Review of the Literature
ramey (1988)

Effective Documentation What We Have Learned from Research
major (1989)

What should you write: a user's guide, tutorial, reference manual, or standard operating …

Tech Commun
(1988)

WordPerfect and WordPerfect Workbook

Show all 34 →

stewart (1988)

Using WordPerfect 5
(1985)

Lotus Development Corporation Getting Started Tutorial and Reference Manual Release 2
gilbert (1989)

The ABC's of 1-2?3 Release 2 2
norman (1976)

Memory and Attention
solso (1988)

Cognitive Psychology
10.1016/S0022-5371(72)80001-X

↗
mayer (1982)

Discourse Processing
flower (1983)

New Essays in Technical and Scientific Communication Research Theory Practice
rumelhart (1981)

Cognitive Skills and Their Acquisition
10.1037/0033-295X.85.5.363

↗
10.3758/BF03197390

↗
harris (1983)

New Essays in Technical and Scientific Communication Research Theory Practice
faigley (1983)

New Essays in Technical and Scientific Communication Research Theory Practice
Mirel (1988)

Cognitive Processing, Text Linguistics and Documentation Writing

Journal of Technical Writing and Communication
halloran (1983)

Essays on Classical Rhetoric and Modern Discourse
christensen (1967)

Notes toward a New Rhetoric
Ramsey (1980)

Grammatical Voice and Person in Technical Writing: Results of a Survey

Journal of Technical Writing and Communication
(1984)

The use of persona in microcomputer software documentation

IEEE Trans Prof Commun
10.1177/002194368502200102

↗
wells (1989)

buyer for computer hooks
de beaugrande (1981)

10.4324/9781315835839

Introduction to Text Linguistics ↗
anthony (1989)

The volatile world of computer books

Publishers Weekly
huckin (1983)

New Essays in Technical and Scientific Communication Research Theory Practice
10.2307/357898

↗
(1982)

The Technology of Text
10.1016/S0022-5371(74)80003-4

↗
10.2307/377199

↗
10.1080/01638538009544494

↗
10.1080/10862968009547385

↗

CrossRef global citation count: 8 View in citation network → Build reading path →

A discourse analysis of software documentation: implications for the profession

Abstract

Citation Context

Cited by in this index (3)

References (34) · 2 in this index

Related Articles