Search NASASearch

Engineering topics

Miller, Diane F.

Publications and source records attributed to Miller, Diane F..

Guidelines for Creating and Using Abbreviations and Acronyms

The unchecked use of acronyms and initialisms in technical writing presents a huge obstacle to clarity and readability. Although technical communicators are certainly more aware of this problem than are the engineers, scientists, and managers with whom they work, they need concrete guidelines and at least a small degree of self-righteousness on this subject to help them cope with the onslaught. That acronyms frustrate communication is well founded in linguistic theory, not to mention common sense. Suggestions for mitigating their destructiveness include issues of audience, term selectivity, frequency and occasion of use, and aesthetics.

Miller, Diane F.

Guidelines for preparing software user documentation

Clear, easy-to-use software user's manuals make strong demands on special technical communication techniques. Principles and guidelines are given for analyzing the audience and dealing with wide-ranging backgrounds of potential users. Types of information to be included in a complete manual are suggested, with a technique for creating a user-oriented rather than process-oriented organization. Accuracy verification is emphasized. Simple tips are gievn for formatting for quick comprehension and reference, for deciding on packaging, for creating helpful illustrations and examples, and for setting up clear and consistent conventions. Simple guidelines are offered for writing clearly and concisely and for editing.

Miller, Diane F.