TECHNICAL WRITING

Technical Writing

Introduction

This paper intends to discuss the significance of technical writing documents. Examples of five different technical writing documents will be explored in the paper and the presentation of each document will be assessed for being professional enough or not. Moreover, a plan for major shopping centre in a style that would be easily understood by the builder and the client of architect will be provided. The significance of providing glossary of terms and a reference list will also be explained in the paper. Various examples of correct referencing will also be provided. A definition of annotated bibliography will also be provided. The purpose of this paper is to make the reader aware about the various important factors related to the field of technical writing.

Discussion

Technical Documents

The first example of the technical writing document is “The End of Web Design” by Jacob Nielson. The article seems to create an immediate positive impression over the readers. The major topics related to the essay were highlighted. The document is completely aligned to the left. No grammatical errors were there as such. Article tends to provide a logical sequence. No relevant graphs were provided. No glossary or reference source was attached. The formatting of the document is not much efficient (Nielson, 2007 Pp. 1-4). The contents were clearly identified within the paper. However, the relevance of contents to the title of document was less.

The next technical document selected is “Web Designers Run Amok; or, How to Slam the Door in Your Reader's Face” by Dennis Jerz. This article looks quite innovative and provided a positive impression to the readers. The document is again aligned to the left. However, no logical sequence was found in the topics within the document. Moreover, the formatting remains quite ineffective (Jerz, 2000 Pp. 2-4). The use of relevant graphs and diagrams is done in an efficient manner. The relevant contents are clearly identified within the paper. The use of white space is done effectively to attract the attention of the readers.

The next technical document selected for the purpose of analysis is “Parasites on the Web: The Jupiter Media Menace” by Dennis Jerz. This article is written in the most efficient manner in order to grab the attention of the readers. The use of white space is done extremely well. The document remains aligned to the left. The document is in an essential logical format. The document provides all the necessary information in relation with the references and glossary. The presentation of this technical writing document is impactful and positive enough to create a positive impression over the readers (Jerz, 2000 Pp. 1-2).

The fourth technical writing document selected for the purpose of assessment is “Towards a Pro-active Technical Writing Curriculum” again by Dennis Jerz. This document appeals me the most as it is assumingly one of the best documents written in relation with the technical writing. The document attracts the attention of the readers at once. The headings are bold and ...