Technical writing and computer programming

Abstract

It is argued that technical writing and computer programming are based on similar principles, perhaps because both are mechanisms for efficiently organizing and communicating complex information. Both technical writing and programming are multistep processes involving planning, drafting, and revising. Moreover, six key aspects of computer programming (modularity, modifiability, user interface, failsafe presentation, style, and debugging) have analogs among such technical writing principles and practices as report sectioning, audience analysis and adaptation, and editing. These similarities are discussed and a course that builds on these likenesses to teach technical writing to programming students is described.< <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
1988-01-01
DOI
10.1109/47.9219
CompPile
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (0)

No articles in this index cite this work.

References (11) · 2 in this index

  1. Problem-Solving Strategies for Writing
  2. Audience Analysis for Technical Writing
  3. Journal of Technical Writing and Communication
  4. Intermediate Problem Solving and Data Structures Walls and Mirrors
Show all 11 →
  1. Journal of Technical Writing and Communication
  2. How to Write Papers and Reports About Computer Technology
  3. Manual of Report Procedure of the Research Laboratories Division
  4. Technical Writing
  5. Designing Technical Reports Writing for Audiences in Organizations