A Structured Approach to Technical Project Documentation

Author:

Annett Clarence H.1

Affiliation:

1. McGraw-Hill Book Company, Overland Park, Kansas

Abstract

The documentation describing a technical project or product frequently takes one of two forms: too little documentation to present the necessary information properly, or too much documentation poorly organized and poorly written. To help overcome this problem, a four-level approach to project documentation is described, with documents assigned to each level according to their intended use. The technical writer can then judge how to construct a given document because the audience for each documentation level is clearly defined.

Publisher

SAGE Publications

Subject

Education,Communication

Reference9 articles.

1. Writing for the Technical Representative

2. Effective Communication of Technical Information to a Nontechnical Group

3. Hall R. C., Lunar Impact: A History of Project Ranger, NASA Special Publication SP-4210, U.S. Government Printing Office, pp. 367–443, 1977.

Cited by 2 articles. 订阅此论文施引文献 订阅此论文施引文献,注册后可以免费订阅5篇论文的施引文献,订阅后可以查看论文全部施引文献

1. Computer Manuals for Novices: The Rhetorical Situation;Journal of Technical Writing and Communication;1986-01

2. Improving Communication: Eleven Guidelines for the New Technical Editor;Journal of Technical Writing and Communication;1985-04

同舟云学术

1.学者识别学者识别

2.学术分析学术分析

3.人才评估人才评估

"同舟云学术"是以全球学者为主线,采集、加工和组织学术论文而形成的新型学术文献查询和分析系统,可以对全球学者进行文献检索和人才价值评估。用户可以通过关注某些学科领域的顶尖人物而持续追踪该领域的学科进展和研究前沿。经过近期的数据扩容,当前同舟云学术共收录了国内外主流学术期刊6万余种,收集的期刊论文及会议论文总量共计约1.5亿篇,并以每天添加12000余篇中外论文的速度递增。我们也可以为用户提供个性化、定制化的学者数据。欢迎来电咨询!咨询电话:010-8811{复制后删除}0370

www.globalauthorid.com

TOP

Copyright © 2019-2024 北京同舟云网络信息技术有限公司
京公网安备11010802033243号  京ICP备18003416号-3