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">&gt;</ETX>

Journal
IEEE Transactions on Professional Communication
Published
1992-01-01
DOI
10.1109/47.158981
CompPile
Search in CompPile ↗
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (0)

No articles in this index cite this work.

Cites in this index (2)

  1. Journal of Technical Writing and Communication
  2. Journal of Technical Writing and Communication
Also cites 10 works outside this index ↓
  1. 10.1016/S0022-5371(72)80001-X
  2. 10.1037/0033-295X.85.5.363
  3. 10.3758/BF03197390
  4. 10.1177/002194368502200102
  5. 10.4324/9781315835839
    Introduction to Text Linguistics  
  6. 10.2307/357898
  7. 10.1016/S0022-5371(74)80003-4
  8. 10.2307/377199
  9. 10.1080/01638538009544494
  10. 10.1080/10862968009547385