style in technical writting

14
STYLE IN TECHNICAL WRITTING A.MADHUMITHA 115011013894 B.TECH-ECE 2 nd year

Upload: mitha-madhu

Post on 20-Mar-2017

59 views

Category:

Engineering


1 download

TRANSCRIPT

Page 1: Style in technical writting

STYLE IN TECHNICAL WRITTING

A.MADHUMITHA115011013894

B.TECH-ECE 2nd year

Page 2: Style in technical writting

Technical Writing Definition

Technical writing is the presentation of information that helps the reader to solve a particular problem.Technical writing is used in proposals, manuals, web pages, lab reports, newsletters, and many other kinds of professional documents. Technical writing is used to communicate information to management, employees, and other businesses.Technical writing can be considered the conduit between people who know technology and those who use it.

Page 3: Style in technical writting

KEY CONCEPTS

1 Know the intended audience.

3

4

5 Prepare a draft and then a final copy.

2 Understand the goal of the document.

Follow the Pyramid Method of Writing.

Use clear and concise language.

Page 4: Style in technical writting

Instruct inform

Persude\performpurpose

Basic technical writing

Page 5: Style in technical writting

It can be recoganized by

simple1

clear2

Straight forward3

Fact-based expressions4

Page 6: Style in technical writting

Outcome/Action

DiscussionDetails/Action

Background

Summary

4 METHOD OF WRITING

A summary is considered the most important information. It tells the readers what will be discussed. Background information answers the who, where, when, and why. The discussion depicts each item or topic and identifies any actions required. The outcome is a general statement of results and any recommendations. Depending on the type of document there may be additional levels of necessary information.

Page 7: Style in technical writting

Know Your Intended Audience

Readers will fall into 1 of 4 categories: experts, technicians, business, and lay-people

1What are the readers' positions and responsibilities?

2

What will the reader be expecting from the document?3

How will the information be

used?

4

Page 8: Style in technical writting

Language and Tone

TONE Tone is created by the language the writer chooses for the audience.

TONE

LANGUAGE Language should be specific to the goal or situation of the document.

LANGUAGE1. Language needs to be concise & well-defined2. Use language that will be understood by the intended audience3. Use narrative language minimally

Tone is used to be persuasiveTone needs to be suitable for the subjectAn active voice sets a decisive tone

Page 9: Style in technical writting

10 point in technical writing

Its should be simple and

clear

organization has to be

proper

Correct sentence construction

should be right and proper

Word chosen should be

technical and direct

Sentence construction in technical

writing

Avoid and negative

sentences

Avoid loading

words and phrases

The tone in technical writing be

kept neutral

The writer should avoid

circumlocationIts could be kept simple

Page 10: Style in technical writting

Technical WritingBasics

Page 11: Style in technical writting

• Technical writing requires transparency of expression and therefore a straightforward use of language.• Technical writing requires the recognition of

the overall goal prior to beginning a document.• Writers must have knowledge of the intended

audience.• Documents must include certain key

concepts so the information can be easily understood by the intended readers. • Technical writing is solution based.

Page 12: Style in technical writting

Action points

• Are action-oriented • Contained safety- and warning

functions • Needed to be translated into

more than one foreign language • Involved more than one writer • Were produced by designers or other persons without education in languages

• Had different target groups.

Research your topic

Research your audience

Know the layout of the report

Begin with the thesis statement

Fill in all pertinent information with correct tone and language

Page 13: Style in technical writting

Four types of technical writing

1Technical Information

2Business Writing

3Requirements for a Position

4User Documentation

Page 14: Style in technical writting

THANK YOU