1.1 Need for Clear and Concise Technical Writing Attributes of Technical Writing Types of Technical Writing Benefits of Technical Writing. | unit 1 introduction fundamentals of technical writing content

Technical Writing

Module - 1

Introduction: Fundamentals of Technica1 Writing Content

1.1 Need for Clear and Concise Technical Writing, Attributes of Technical Writing, Types of Technical Writing, Benefits of Technical Writing.

Need for Clear and Concise Technical Writing- Technical writing is the ability to simplify complex concepts for a specific audience. Great technical writing does more than just get the message across — it helps engage readers and motivate them to learn more about a subject.

Clear and concise technical writing is needed for Producing content that’s easily readable, engaging and logically segmented to draw reader interest. This is no simple task.

characteristics_of_effective_content

Attributes of Technical Writing- Technical writing, just as any other form of writing, has certain characteristics which distinguish it from other types of writing. It is very different from writing opinion pieces, essays, prose, non-fiction or fiction.

It is clear and straight forward. If you are interested in technical writing for professional purposes, it is very important to know that this type of writing requires that the writer stick to the subject matter and relay information in a clear and concise manner.

The language is very direct and straight to the point. The writing will avoid words that people do not understand and will avoid an eloquent writing style.

It is very detailed and informative. The perfect example of technical writing is a textbook. The written content of most textbooks is geared to providing information by describing the subject matter as fully as possible.

It is very structured. This type of writing has a very obvious composition that makes it easy for the reader to follow along. Solid structure is needed with technical writing as it allows the audience to easily access the information as needed.

Types of Technical Writing- Technical writing provide detail-oriented instruction to help users understand a specific skill. The most common types include:

Traditional: Repair manuals, medical studies

End-user documentation: Electronics, consumer products

Technical marketing content: Press releases, catalogs

Benefits of Technical Writing-

Clearer Communication-

A high-quality, well versed documentation and manuals reflect well on your organization. Readers will translate the level of competency revealed through the documentation onto your brand. Contract technical writers help clarify complicated concepts through translating developer jargon into simpler language, helping your organization meet the needs of your target audience.

2. Awareness-

Technical writers consider content from the user’s perspective. Technical writers are aware and know how to connect to your audience, and they have the special talent of understanding complex content from both the viewpoint of industry-experts and the average consumer. They are capable of understanding the unique needs of your audience, which will allow them to create effective technical communications that will resonate well.

3. Reduced Costs

Professional technical writers have the skill and knowledge necessary to complete a coherent end-product faster with the specific needs of the product market in mind. Eventually, well written and understood manuals will result into a reduction of service calls to your technical-support department.

4. Professional Formatting & Presentation

From the document layout and font to the appropriate size for charts, a technical writer is able to make your content look professional. Your documentation is one element of many that complete your company brand. It is just as much part of your product as its other features and should complement it accordingly. Colors, styles, and logos can go a long way to making the documentation look like your documentation.

1.2 Managerial and General Readers, Expressing versus Impressing.

Managerial and General Readers-

Expressing versus Impressing- As verbs the difference between impress and express is that impress is to affect (someone) strongly and often favorably while express is (sense id) to convey or communicate; to make known or explicit.

As nouns the difference between impress and express is that impress is the act of impressing while express is a mode of transportation, often a train, that travels quickly or directly or express can be (obsolete) the action of conveying some idea using words or actions; communication, expression.

1.3 Correct use of Noun, Pronoun, Verb, Adjective, Adverbs, Tense and Punctuation.

Correct use of Noun- Group words, or collective nouns, are followed by singular verbs when we are talking of the group as a whole. They take a plural verb when we are talking about the individual members of the group.

Nouns that always need a plural verb

Some nouns are always followed by plural verbs. Examples are: binoculars, scissors, spectacles, glasses, trousers etc. Note that it is wrong to say ‘a binocular’ or ‘a spectacle’.

Cases where a singular verb is necessary

When a singular noun and a plural noun are connected by or, the verb agrees with the nearest noun.

Grapes or a melon is suitable. (Here we use a singular verb because the nearest noun (melon) is singular in number.)

A melon or grapes are necessary. (Here we use a plural verb because the nearest noun (grapes) is plural in number.)

Pronoun- A pronoun is a word that is used instead of a noun or noun phrase. Pronouns refer to either a noun that has already been mentioned or to a noun that does not need to be named specifically.

For instance, if you’re telling a story about your sister Seetal, the story will begin to sound repetitive if you keep repeating “Seetal” over and over again.

Example: Seetal has always loved fashion. Sarah announced that Sarah wants to go to fashion school.

Verb- Verbs are the action words in a sentence that describe what the subject is doing. Along with nouns, verbs are the main part of a sentence or phrase, telling a story about what is taking place. In fact, without a verb, full thoughts can’t be properly conveyed, and even the simplest sentences, such as Maria sings, have one.

A verb is a "doing" word. A verb can express:

A physical action (e.g., to swim, to write, to climb).

A mental action (e.g., to think, to guess, to consider).

A state of being (e.g., to be, to exist, to appear).

Adjective- Adjectives are words that describe or modify other words, making your writing and speaking much more specific, and a whole lot more interesting. Words like small, blue, and sharp are descriptive, and they are all examples of adjectives. Because adjectives are used to identify or quantify individual people and unique things, they are usually positioned before the noun or pronoun that they modify. Some sentences contain multiple adjectives.

In the following examples, the highlighted words are adjectives:

They live in a big, beautiful

Since it’s a hot day, Sita is wearing a sleeveless

The mountaintops are covered in sparkling

Adverbs-a word or phrase that modifies or qualifies an adjective, verb, or other adverb or a word group, expressing a relation of place, time, circumstance, manner, cause, degree, etc.

.Adverbs are words that modify

a verb (He drove slowly. — How did he drive?)

an adjective (He drove a very fast car. — How fast was his car?)

another adverb (She moved quite slowly down the aisle. — How slowly did she move?)

Tense- any of the forms of a verb which show the time at which an action happened.

There are mainly three types of Tenses, they are:-

The Present Tense:

The verb that refers to the present time is said to be in the present tense; as

I write this letter to help you.

The Past Tense:

The verb that refers to the past time is in the Past Tense.; as

I wrote this letter yesterday.

The Future Tense:

The verb that refers to the future time is in the Future Tense,; as

I shall write another letter.

Punctuation- is the practice action or system of inserting points or other small marks into texts in order to aid interpretation; division of text into sentences, clauses, etc., by means of such marks.

Punctuation marks are essential when you are writing. They show the reader where sentences start and finish and if they are used properly they make your writing easy to understand.

how_to_teach_punctuation

Reference books

1. “A Guide to Technical Writing”, T. A. Rickard, Franklin Classics.

2. “Technical Writing”, S. Jayprakash, Himalaya Publishing House Pvt. Ltd.

3. “Technical Writing”, O. N. Pandey.

Sign Up

Index

Notes

Highlighted

Underlined

Browse by Topics

Notes

Highlighted

Underlined