Scribd
Upload
11 views

Lecture2 PDF

Uploaded by

khaledgamalaldinmuhammadelmola
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
11 views

Lecture2 PDF

Uploaded by

khaledgamalaldinmuhammadelmola
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

Civil Engineering Department

1st Semester – 2024 /2025


Code: GEN201- 2Level
Course: Technical writing report
Characteristics of technical writing

Characteristics of Technical Writing

What are Characteristics of an effective technical writing?

Effective technical writing must have the following distinct characteristics .

1. Clear and capable of being understood easily.


2. Well organized and structured.
3. Use of prevalent technical terms in the field.
4. Use of an appropriate language.
5. True and based on actual facts.
6. It must serve the purpose for which it is written.

What is meant by report is Clear and capable of being understood


easily?

Clear and capable of being understood easily:

The writer should say exactly what he means, and should say this so clearly
that they may not be misunderstood. A technical report must be clearly
understandable by the expected readers or audience. The use of adequate
vocabulary, along with prevalent technical terms of the field should be used.
An appropriate syntax and style of writing may help in increasing the clarity.
What is meant by report is well organized and structured?
Well organized and structured:

The technical report must be well organized and structured. If the author is not able
to organize his material properly and in logical sequence, it may lead to total
confusion and lack of clarity.

What is importance of using prevalent technical terms in the field?

Use of prevalent technical terms in the field:

Technical terms which are being used in the field should be preferred to be used in
technical writing. If the technical report is intended for readers not acquainted with
the specialized words, then the technical terms should be explained in a foot note.
The writer should never assume that the audience knows everything.

What is importance of using an appropriate language?

Use of an appropriate language:


The language of the technical report should be direct and straight to the point. The
difficult word, cliches or jargon must be avoided. Grammar, punctuation and syntax
should be proper, and adequately taken care. The perfect example of a technical
report is a text book. All the relevant information up to a particular level is provided
in text books. A text book intended for graduate level may be entirely different from
the one, designed for research purposes. A research purpose book may contain the
total review of scientific work done in that field. Such advanced-knowledge text
books may help in exploring the new frontiers of technology. However, If the
technical writing is for a brochure to promote a product, it should be brief and
precise. At the same time, it must not miss necessary information. In such cases
precision and brevity are important.

Mention how technical writing must serve the purpose for which it
is written?

It must serve the purpose for which it is written:


Effective technical report must serve the interest or purpose of the audience, for
whom it is written.

Technical writing is a type of writing where the writer uses specific language to
explain a particular topic. This kind of writing is used for technical documents such
as manuals, instructions, and tutorials. A Technical writer uses specialized
terminology and complex sentence structures to communicate ideas effectively. A
Documentation writer makes sure that every document has been prepared correctly
before submitting it. They write documentation for various reasons.
It is important to understand the form of writing required for each document. For
instance, if you need to write a manual, it will require you to use simple sentences,
short paragraphs, and bullet points. You also have to make sure that you include all
the details about your product. The best way to do this is by using diagrams and
images, because they can show you exactly what you want to say.
Understanding the intended audience will help you determine the most suitable style
for your document. When writing, remember that there is no right or wrong way to
do things; however, certain conventions are followed when communicating with
others. These conventions are called Standard English. Standard English is the set
of rules and conventions that people follow when speaking and writing.
A good writer should know how to write clearly and concisely. There is a
difference between clear writing and concise writing.

Technical writing examples include:

 Instructional materials
 Tutorials
 User manuals
 Instructions
 Guidelines
 Reports
 Presentations
 Brochures
 Articles
What are Technical writing skills?

Technical writing skills would include:


 Understanding the audience.
 Writing for clarity.
 Using good grammar and punctuation.
 Being consistent.
 Having a logical flow.
 Making sure all information is correct.
 Including enough detail so readers won’t have to look up anything.
 Being organized.
 Following the standards of whatever organization you work for.
 Knowing when to use tables and figures.
 Knowing when not to use them.

How does effective technical writing differ from bad technical


writing?

There are two main differences between good technical writing and bad technical
writing. First, good technical writers focus on their audience. Second, good technical
writers write with clarity and conciseness. Bad technical writers often fail to meet
these criteria.

You might also like