Fill This Form To Receive Instant Help

Help in Homework
trustpilot ratings
google ratings


Homework answers / question archive / 1) Find a good or bad technical document (e

1) Find a good or bad technical document (e

Computer Science

1) Find a good or bad technical document (e.g. manual, instructions on a website etc.) (1 point)

2-specify what features make it good or bad in details (2 points)

3-in general with explains say at least 5 what makes any sample document good or bad. (1 point)

 

pur-new-sol

Purchase A New Answer

Custom new solution created by our subject matter experts

GET A QUOTE

Answer Preview

 

 

2-         This document is an example of a good technical document.

            First, it is comprehensive because it goes over all of the parts of the computer (top view, left-side view, right-side view, and bottom view), and it explains the details of starting to use the operating system of the computer, understanding the recovery system, and troubleshooting.

Second, it is concise which makes it easier to use and understand. It only states what needs to be said without omitting any important information. All of the sentences are relatively short (less than 25 words) and contain simple terms that any user can understand. 

Third, it makes use of a lot of annotated explanatory images. These make it easier for the user to understand the different components of the computer, and the way to set it up. 

Fourth, the document is organized into clear categories that are stated in the table of contents: “Getting to know your computer”, “Starting to use Windows 10”, “Recovery system, Troubleshooting”, and “Trademarks”. This organization makes it easier for the reader to reach an answer in a fast and efficient manner. 

Last, the document is appropriate for its intended audience, which is the general public. This product is made to be used by anyone and does not require technical skills. The document is easy to understand by anyone, which makes it good.

            However, the document has a disadvantage: it does not sum up each section at the end. A good document should repeat some of the most important parts mentioned in its conclusion.

3-         Good technical documents have the following:

  1. A good technical document must be appropriate for its intended audience. The audience can be anyone from scientists or engineers, business people, or even a general audience. The technical document must not be too easy for its audience because it will be criticized, and it also mustn’t be too complicated because it will not be understood.
  2. The technical document should also be comprehensive. It should explain the topic in great detail, going over every component of the product. It should not skip any attribute or component of the product.
  3. The document must be concise and to the point. The writer must not use more sentences than needed, and any figures of speech must be avoided to avoid wordiness and confusion of the readers.
  4. Logic is crucial in a technical document. The information contained inside the document must be sequential and non-contradictory. The steps should make sense and be in sequential order, not in random order. This will make the instructions easy to follow.
  5. Action verbs are used throughout the document everywhere possible. This is because a technical document is action-oriented, and it helps users take action to solve their problems.

 Bad technical documents, on the other hand, have the following:

  1. A bad technical document lacks images and visual representations. It makes it hard (and sometimes even impossible) for the reader of such documents to understand each component of the product.
  2. A bad technical document is also too wordy, and filled with technical jargon. Using figures of speech also makes a document bad. These things make it hard for the reader to understand instructions; the document becomes unreadable to some users.
  3. When a document is not appropriate for its intended audience, it is considered bad. For example, if a product is intended for use by the general public, its manual must be easy to understand, and its instructions easy to follow. Complicated scientific and technical words should be avoided in this case.