Technical Writing for Software Engineers

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

Abstract:

This module, which was written specifically for software engineers, discusses writing 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.

Author(s):
Levine, Linda ; Pesante, Linda H. ; Dunkle, Susan B.
Author Organization(s):
CARNEGIE-MELLON UNIV PITTSBURGH PA SOFTWARE ENGINEERING INST
Supplementary Note:
DOI: 10.21236/ADA636493
Pagination:
0090

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):
F1962890C0003
Monitor Series:
ESD
 Subject Terms
Joint Capability Areas:
JCA_5_Command and Control; JCA_5.3_Planning; JCA_5.3.1_Analyze Problem; JCA_6_Net Centric; JCA_5.3.2_Apply Situational Understanding; JCA_5.2_Understand; JCA_6.1_Information Transport; JCA_5.3.3_Develop Strategy; JCA_1_Force Support; JCA_5.2.3_Share Knowledge and Situational Awareness; JCA_1.2_Force Preparation; JCA_5.3.4_Develop Courses of Action; JCA_5.3.5_Analyze Courses of Action; JCA_4.6_Engineering; JCA_1.2.3_Educating; JCA_1.2.1_Training; JCA_5.5.2_Task; JCA_5.5_Direct; JCA_6.2.3_Core Enterprise Services; JCA_1.2.6_Concepts; JCA_5.4_Decide
Communities of Interest:
Engineered Resilient Systems
Descriptor(s):
*SOFTWARE ENGINEERING, *TECHNICAL WRITING, COMPUTER PROGRAMS, ENGINEERS, LINGUISTICS, THEORY
Field(s)/Group(s):
Information Science, Computer Programming and Software
Keyword(s):
RHETORICAL THEORY, DISCOURSE ANALYSIS, DOCUMENT DESIGN, WRITING PROCESS
Report Date:
1991 Nov 01
Creation Date:
2016 Aug 31