Technical Writing for Software Engineers

reportActive / Technical Report | Accession Number: ADA223872 | Open PDF

Abstract:

This module, which is directed specifically to software engineers, discusses the writing process in the context of software engineering. Its focus is on the basic problem-solving activities that underlie effective writing, many of which are similar to those underlying software development. The module draws on related work in a number of disciplines, including rhetorical theory, discourse analysis, linguistics, and document design. It suggests techniques for becoming an effective writer and offers criteria for evaluating writing. Keywords Programming writing documentation.

Author(s):
Levine, Linda ; Pesante, Linda H. ; Dunkle, Susan B.
Author Organization(s):
CARNEGIE-MELLON UNIV PITTSBURGH PA SOFTWARE ENGINEERING INST
Descriptive Note:
Final rept.
Pagination:
0069

Security Markings

DOCUMENT & CONTEXTUAL SUMMARY

Distribution:
Approved For Public Release
Distribution Statement:
Approved For Public Release; Distribution Is Unlimited.

RECORD

Collection: TR
Identifying Numbers
Report Number(s):
SEI-CM-23
Contract/Grant Number(s):
F19628-90-C-0003
 Subject Terms
Joint Capability Areas:
JCA_5_Command and Control; JCA_5.3_Planning; JCA_5.3.1_Analyze Problem; JCA_5.3.2_Apply Situational Understanding; JCA_5.2_Understand; JCA_1_Force Support; JCA_6_Net Centric; JCA_1.2_Force Preparation; JCA_5.2.3_Share Knowledge and Situational Awareness; JCA_6.1_Information Transport; JCA_5.3.4_Develop Courses of Action; JCA_5.3.5_Analyze Courses of Action; JCA_1.2.3_Educating; JCA_4.6_Engineering; JCA_8_Building Partnerships; JCA_1.2.1_Training; JCA_5.5.2_Task; JCA_5.5_Direct; JCA_8.1_Communicate; JCA_1.2.6_Concepts; JCA_5.2.2_Develop Knowledge and Situational Awareness
Communities of Interest:
Human Systems
Descriptor(s):
*TECHNICAL WRITING, *COMPUTER PROGRAMMING, *PROGRAMMERS, LINGUISTICS, WRITING, PROBLEM SOLVING, COMPUTER PROGRAMS, ENGINEERS
Field(s)/Group(s):
Computer Programming and Software
Keyword(s):
*SOFTWARE ENGINEERS, PE63752F
Report Date:
1990 May 01