A perspective on computer documentation: System developer vs. technical editor

Conference · Sun Dec 31 04:00:00 EST 1995

OSTI ID:192489

Carnes, E T; Truett, L F

Between the computer-knowledgeable {open_quotes}techie{close_quotes} and the technical writer is a chasm created by differences in knowledge bases and skills. Although this gap is widened by misunderstandings and misconceptions of system development roles, it is bridged by mutual need and dual appreciation. Often the editor/writer is {open_quotes}behind{close_quotes} from beginning to end. The writer normally joins the team after the programmers are well into system development and do not want to {open_quotes}waste time{close_quotes} discussing fundamentals. The writer is usually excluded from technical discussions because it is assumed that he/she would not understand anyway. Later in the system development cycle, the writer has no time to polish the documentation before a new version of the software is issued which implies that the documentation must be revised. Nevertheless, the editor/writer`s product is critical for the end-user`s appreciation of the software, a fact which promotes unity to complete the comprehensive package of software and documentation. This paper explores the planks in the bridge that spans the chasm between developers and their fundamental PR agents, the technical editors/writers. This paper defines approaches (e.g., The Circling Theory) and techniques (Bold Thrust!) employed for effective communication -- between software developer and technical writer as well as between the software and the end-user.

• Research Organization: Oak Ridge National Lab., TN (United States)
• Sponsoring Organization: USDOE, Washington, DC (United States)
• DOE Contract Number: AC05-84OR21400
• OSTI ID: 192489
• Report Number(s): CONF-9510245--3; ON: DE96004554
• Country of Publication: United States
• Language: English

Related Subjects

99 GENERAL AND MISCELLANEOUS
COMPUTER CODES
COOPERATION
DESIGN
PROGRAMMING