Title :
The technical writer as software process catalyst
Author :
Scott, Kendall V.
Author_Institution :
Stand. Document Inc., Los Gatos, CA, USA
Abstract :
The emergence of a new economy, fueled by business-to-business e-commerce and moving toward things like component-based development, and soon to be dominated by browser-based applications, is creating a shift in focus away from user documentation and towards what we might refer to as systems documentation. This term encompasses any kind of documentation that describes the technical aspects of a software system for people like systems analysts, modelers and software engineers, rather than users. Technical writers need certain specialized skills, such as the ability to analyze Java code, and knowledge involving subjects like component-based development to thrive in this new world. The author considers how tech writers should be able to combine systems documentation skills with their existing communication skills in order to serve as catalysts within software development projects, in contrast to their traditionally less active and visible roles
Keywords :
software engineering; system documentation; technical presentation; Java code; browser-based applications; business-to-business e-commerce; communication skills; component-based development; software development projects; software process catalyst; systems documentation; technical writing; user documentation; Application software; Code standards; Companies; Documentation; Internet; Java; Programming; Software standards; Standards development; Teamwork;
Conference_Titel :
Professional Communication Conference, 2000. Proceedings of 2000 Joint IEEE International and 18th Annual Conference on Computer Documentation (IPCC/SIGDOC 2000)
Conference_Location :
Cambridge, MA
Print_ISBN :
0-7803-6431-7
DOI :
10.1109/IPCC.2000.887283