Short analytical report based on finding a technical document

Topics: Technical communication, Technical writer, Technical writing Pages: 8 (1933 words) Published: August 9, 2007
�PAGE � �PAGE �8�

INTRODUCTION

1.1 Background

The successful organization is the one that communicates well both internally and with other companies and clients. In fact, information flow is crucial to any organization and the better the flow the more successful it is.

At work a great of information is convoyed in technical documents, some of the tasks tackled by their writer are; proposals, reports, instruction. Technical writing communicates highly specific information. Most of it is prepared by professionals, such as engineers, scientists and other technicians. Even though it presents technical, a technical document should be easy to understand.

1.2 Aim

The purpose of this report is to explain, discusses and analysis in variable majority aspect of technical document to help the readers in better understand of technical document writing. By using the Pioneer's car stereo head unit operation manual as a practical example of technical document which will support with theory basis and journal articles.

Scope

The scope of this report includes:

( Analysis and assess its attention to audience.

( Analysis and evaluate of the organization strategies.

( Analysis and evaluate of graphic

( Analysis and evaluate of word choice.

( Analysis and evaluate of sentence style.

( Emphasize the importance correct, objective language

Audience focus.

According to Dwyer, (2003) technical writers must identify the intended audience first and then organize and shape the content of the document so that their audience grasps the main points easily.

As this report used the Pioneer's car stereo head unit operation manual as a practical example. It can be conclude that the main audiences of this document are people with non-technical background. This because the operation manual were give to the general end user of the product, therefore it is more reasonable for the writers to assume that the readers do not have technical background or knowledge. Moreover, it can be seen that the document avoids using technical word and always have explanation in some circumstances that can not be avoided, these also support by Kennedy (2004 pg. 22), his article state that "Technical terms and words function as helpful shorthand when addressing documentation to readers within a profession, but they may confuse readers who do not have that special background." In addition, the first section named 'Before you start' gives the reader explanations of some specific term used in the document as well as the second section 'What's What' which also help the general reader familial with the hardware component of the head unit, as these are very good idea of the writers.

Hence, from the discussions above it can be seen that the writers of this document are not only focus on non-technical audience. They also gave knowledge to help in prepare the reader for better understand the product.

Organization

As state in Karin article, for technical writer spend much time providing instructions by a series of ordered steps and providing background information that builds on prior material and tasks already completed. These are necessary because if the writers fail to discuss a basic topic before moving on to a related advanced topic they most likely will get confused (Karin, N.D.).

According to the operational manual, we can see that the writer organize the document very well. First, the content section at the beginning of the manual, which help the reader jump to their point of interest quickly. Second, the consistent in using numbers, punctuation, grammar, symbols and technical terms, which help to creates a comfortable zone for the reader and avoids confusion. Third, the writers of the document break down the document into short sections and paragraphs to make it easier to read and the used of headings and subheadings also help the readers understand the importance of each section. (see appendix …).

In conclusion,...


References: Brucker, C. 2002, Graphics in Technical Writing Part One, viewed 6 August 2007,
http://lfa.atu.edu/Brucker/Graphics%201%20Presentation/index.htm
Dwyer, J. 2003, The business communication handbook, 6 edn, Pearson Education, Malaysia.
Karin, J. N.D., Software Documentation, viewed 6 August 2007, http://www.suite101.com/lesson.cfm/17509/752/3
Kennedy M.P. 2004, Technical Writing Tips, Tech Directions. Ann Arbor: Nov 2004. Vol. 64, Iss. 4; pg. 22, 2 pgs (online ProQuest)
Leaper, N. 2005, Lessons on cross-cultural communication, Communication World. San Francisco: Jul/Aug 2005. Vol. 22, Iss. 4; pg. 14, 1 pgs (online ProQuest)
The Learning Centre, N.D. Technical Writing: Features & Conventions, viewed 6 August 2007, http://www.lc.unsw.edu.au/onlib/tech2.html
Tyme, T. 2007, Technical Writing, viewed 6, http://www.tesseraltyme.com/technical_writing.asp
Continue Reading

Please join StudyMode to read the full document

You May Also Find These Documents Helpful

  • Essay on Analytical Report
  • Introduction to Technical Report Writing Essay
  • Essay about Analytical Report
  • Technical Report Essay
  • Technical writing Essay
  • Short Report Essay
  • Short Report Essay
  • Short Report Essay

Become a StudyMode Member

Sign Up - It's Free