Академический Документы
Профессиональный Документы
Культура Документы
Dr Amrtha Bhide
Assistant Professor, Department of Physics
NIT-Puducherry
Email: abhide.nitpy@gmail.com
1
7/23/2018
2
7/23/2018
Technical Document
Business communication
Resume
Cover letters
Customer relations letter
HR letters
Trip reports
Administrative communications
3
7/23/2018
Technical reporting
Progress report
Feasibility studies
Specifications
Proposals
Manuals- Procedures
Planning documents
Safety analysis
Bug reports
Scientific writing
Books
Journals
Magazines
Conference proceedings
News letters/Websites/blogs
4
7/23/2018
Scientific Document
A precise document, which conveys an
information as concisely and correctly as
possible.
Free from any intent to evoke an emotional
response from the reader.
BOOKS
• Books are very wide and archival sources for
distribution of knowledge and ideas.
• Long time to write, edit and to publish.
• Books need limited review.
JOURNALS
• Journals are the preferred venue for publication
of important scientific ideas and technical
breakthroughs.
• Articles focused more on theory/models than
applications.
• Prior to publication the articles undergo reviewed
by experts to check the quality.
• Take months to years to publish one article in
certain journals.
5
7/23/2018
MAGAZINES
• Published within a community for sharing
professional, political, relational aspects.
CONFERENCE PROCEEDINGS
• Conferences are meetings where researchers
present scientific findings often in preliminary
stage.
• Article published in proceedings may be in the
form of abstract, or a consolidated paper of
already published articles.
• Conference abstracts are peer-reviewed and the
articles will be published within few months of
the conclusions of the conference.
• There is wide range of practices and quality of
conference proceedings publications.
6
7/23/2018
NEWSLETTERS- WEBSITES-BLOGS
• News letters are informal publications produced
by some community of interest. Ex: a special
interest group and some professional society etc.
• It takes only few days to expose an idea for rapid
consideration, and discussions.
• They do not have prestige of journals, magazines
or conferences.
• Websites and blogs are of instantaneous
publications, the accuracy of the content may be
sometimes questionable.
7
7/23/2018
8
7/23/2018
9
7/23/2018
10
7/23/2018
11
7/23/2018
Illustration
Original version Reworked word
The mechanism needs The mechanism needs substantial
substantial amount of redesign redesign
There are many replacement There are many replacement parts
parts out there available.
The possible reasons of the The possible reasons of the system
system failure are many fold failure are numerous.
A really strong odour was A powerful odour was noticeable
noticeable
starting off the procedure is not Beginning the procedure possible
impossible
A repair kit must go along with A repair kit must accompany with
the unit the unit
12
7/23/2018
13
7/23/2018
14
7/23/2018
Intended Faulty
beet beat
costumers Costumers
Object -orientated Object oriented
density destiny
Phosphorus phosphorous
15
7/23/2018
16
7/23/2018
17
7/23/2018
6. 5C s of Technical writing
Correctness
It means that the information in the article is
grammatically and technically correct.
18
7/23/2018
5C s of Technical writing
Clarity:
A document must be unambiguous. Group of
sentences, related sections of the written
document can have only one interpretation.
Ex: For this experiment the measured parameter
is found to be 20m/s, which occurs when certain
exceptional conditions occur. This conditions
include poor grading in the scale, calibration and
improper tool. According to the user manual
cause of the problem is relatively minor.
5C s of Technical writing
Complete:
• A technical document must be complete- if
there is no missing ‘relevant’ or important
information.
• Completeness is a difficult quality to prove
any writing.
19
7/23/2018
5C s of Technical writing
Consistency:
Internal consistency: That means one
part of the document should not
contradict another part.
External consistency :The document
is in agreement with all other
applicable documents and standards.
Consistency can be checked through reviews
and can be repaired in subsequent versions of
the documents.
5C s of Technical writing
Changeable.
A document is said to be changeable , if the
structure of the document will readily yield the
modification.
The document and sections are numbered,
and stored in compatible electronic format,
and compatible with common document
processing and configuring tools.
Reduces Burdon of modification.
Readily edited for reviews/ conference and
journal manuscripts etc.
20
7/23/2018
● Journals
● Conference Paper
● Analytical Paper
● Survey Paper
● Review Paper
21
7/23/2018
Journals
● Published in issue of a journal
● Scholarly periodicals-aimed at specialist and
researchers
● Written by experts contain original research
and conclusion based on data
● Footnote, endnote, abstract and bibliography
● Generous page limit
● Takes minimum 6 months to publish(in reputed
journals)
Conference Paper
22
7/23/2018
Analytical Paper
● focus on facts instead of opinions.
● Research, conclusions, and other findings
completed by researchers are highlighted in the
paper.
● study different viewpoints presented on a set topic
or subject without forming an opinion.
Survey Paper
23
7/23/2018
Review Paper
What is abstract?:
•An abstract is a self-contained, short, and powerful
statement that describes a larger work.
Types of Abstracts
•Descriptive
•Informative
24
7/23/2018
Types of abstracts:
Descriptive abstract
● Provides a description about the report’s main
topic
● You don’t summarize any facts or conclusion
● Short - usually less than 100 words.
Purpose of the work
Method used
Scope of the work
Doesn’t include: – results, conclusions
Example:
This study investigated the role of "signalling" in helping good readers
comprehend expository text. As the existing literature on signalling,
reviewed in the last issue of the Journal, pointed to deficiencies in
previous studies' methodologies, one goal of this study was to refine
prose research methods. Two passages were designed in one of eight
signalled versions each. The design was constructed to assess the
individual and combined effect of headings, previews, and logical
connectives. The study also assessed the effect of passage length,
familiarity and difficulty. The results showed that signals do improve a
reader's comprehension, particularly comprehension two weeks after the
reading of a passage and comprehension of subordinate and super
ordinate inferential information. This study supports the hypothesis that
signals can influence retention of text-based information, particularly
with long, unfamiliar, or difficult passages.
25
7/23/2018
Informative abstract
● It provides key facts and conclusions
● Usually about 10% of the length of the full report
● Fairly short - from 200 words to a page or more.
Example:
The opportunity to design and deliver short programs on
referencing and avoiding plagiarism for transnational Uni
SA students has confirmed the necessity of combating
both the ‘all-plagiarism-is-cheating’ reaction and the
‘just-give-them-a-referencing-guide’ response. The notion
of referencing is but the tip of a particularly large and
intricate iceberg. Consequently, teaching referencing is
not adequate in educating students to avoid plagiarism. In
this presentation, I will use the transnational teaching
experience to highlight what educating to avoid
plagiarism entails.
26
7/23/2018
Word processor
LaTex
Math-type
Equation editor
Graphic/ plotting tools
Referencing:
27
7/23/2018
Referencing:
Always ask permission before listing someone as
reference.
List the references who can discuss your abilities
and experiences.
List at least one reference of someone who
works or has worked for you (if you are supervisor).
Try to list at least one reference for each job that you
ascertain the article.
Don’t list unnecessarily friends/ relatives and other
whom you know personally.
Referencing style:
Modern Language Association.
American Institute of Physics
The Institute of Electrical and Electronics
Taylor and Francis
American Chemical society
Oxford
Reference compilers:
Endnote, Mendeley, Zotero
28
7/23/2018
Referencing style:
Citation:
A “citation” is the way you tell your readers that certain
material in your work came from another source. It
also gives your readers the information necessary to
find that source again, including:
Information about the author
The title of the work
The name and location of the company that
published your copy of the source
The date your copy was published
DOI: Digital Object identifier if the paper is not
assigned with page/ volume details
The page numbers of the material you are borrowing
29
7/23/2018
Paraphrasing:
Paraphrasing is using your own words to
express the ideas or thoughts contained in a
passage that you have read.
Quoting:
Taking the exact words from an original source is
called quoting.
When you quote someone else's words, you must
put those words in quotation marks.
When you quote, you must use the exact words
that are in the quotation, in exact sequence.
It is ok to quote part of a sentence as an element in
a longer sentence of your own
30
7/23/2018
Quoting: Rules
Rule 1: Commas and periods always go inside the
closing quote marks.
Summarizing:
Summarizing means that you are explain ideas
or facts that you found in someone else's work ,
but you are explaining them in your own words,
using your own word order.
31
7/23/2018
Plagiarism
The word plagiarize actually comes from
the Latin plagiar-to kidnap.
Types ?
Clone
Ctrl-C Recycle
Copy-Replace Hybrid
Remix Mashup
Beware ! Never be victim of it.
32
7/23/2018
CLONE
An act of submitting another’s work, word-for-word,
as one’s own.
Ctrl-C
Contains Significant portions of text from a single
source without alterations.
Find-Replace
Changing key words and phrases but retaining the
essential content of the source.
Remix
Paraphrases from multiple sources, made to fit
together.
Recycle
Borrows generously from the writer’s previous work
without citation.
Mashup
Mixes copied material from multiple sources.
Hybrid
Combines perfectly cited sources with copied passages
without citation.
33
7/23/2018
Self Plagiarism
Copying material you have previously produced and
passing it off as a new production.
Unintentional Plagiarism
Paraphrasing poorly
changing a few words without changing the sentence
structure of the original, or changing the sentence
structure but not the words.
Quoting poorly-
Not putting proper quotation marks
Citing poorly- citing inaccurately
Intentional Plagiarism
• Passing off as one’s own pre-written papers from
the Internet or other sources.
• Copying an essay or article from the Internet, on-
line source, or electronic database without
quoting or giving credit.
• Cutting and pasting from more than one source
to create a paper without quoting or giving
credit.
• Borrowing words or ideas from other students or
sources without giving credit.
34
7/23/2018
Preventing Plagiarism
In a research paper, you have to come up with your
own original ideas while at the same time making
reference to work that’s already been done by others.
Consult with your instructor
Plan your paper
Take Effective Notes
When in doubt, cite sources
Make it clear who said what
Know how to Paraphrase
Evaluate Your Sources
Process of publishing
Brainstorming Drafting Revising
20% 40% 25%
Publishing
Editing 10%
5%
35
7/23/2018
36
7/23/2018
Oral communication
37
7/23/2018
Objectives
• To Inform
• To Educate
• To Convince
• To Persuade
• To Lead to Action
How do you
Who is your audience?
Present?
38
7/23/2018
39
7/23/2018
Planning:
Opening : grab attention
Introduction “this topic?”
Body –” bulk of the presentation’
Remember that for every important point that
you make, support can be taken in the form of
Statistics, analogies, testimony, illustrations, or
specific examples.
Conclusion – summarize briefly points
Close – last strong sentences that leave the audience
with something to remember
40
7/23/2018
41
7/23/2018
Openings
Grab audience’s attention so that they will want to hear
what you have to say
Poor Openings
• Long or slow-moving quotation
• Self introduction
• Apologetic statement
• Story, joke or anecdote which does not
connect to the theme
• Stale remark
• Statement of your objective
42
7/23/2018
43
7/23/2018
Color
Avoid red-green combinations because a large fraction
of the human population is red-green colorblind.
44
7/23/2018
Color
45
7/23/2018
Visual Medium-How?
• Visuals support the speech, they are NOT the
primary message
• Visuals are only used to dramatize and clarify the
message
• Practice your main points of the presentation
without relying on the visuals
• Visuals should assist you in controlling
– Pace of the presentation
– Flow of the information
• Important! – When you transition from one visual to
the next, introduce the topic area of the next visual
before it is revealed.
46
7/23/2018
Presentation Delivery
• Body language
– Contributes 55% toward message impact
• Tone of voice
– Contributes 38% toward message impact
• Actual words
– Contributes 7% toward message impact
• Time control
– Contributes 90 % toward message impact
47
7/23/2018
Time Control
• Prepare SEVERAL versions:
– 5 minute presentation of your research (on the
way to the train station or in the elevator)
– 15 minute presentation of your research (in
conference)
– 45-50 minute presentation of your research (in job
talk, invited talk, keynote)
– 55-100 minute presentation of your research (in
classroom)
• Be in control of time
– You may loose audience otherwise
Closing of Presentation
Accent your speech objectives
Leave the audience with something to remember
Closing is the “whip-cracker”, the “clincher”,
ultimately the “result getter”.
Closing can be dramatic, emotional, humorous
Closing does not have to have words; you can use
props, gestures, a demonstration or silence
Closing must tie with your opening and your
theme
Poor closing can seriously detract from an
otherwise excellent presentation
48
7/23/2018
Good Closings
• Call or an appeal for definite action
• Appropriate short quotation or illustration
• Exhibit – an object, article, picture
• Personal challenge
Poor Closings
• Commonplace statement delivered in a
commonplace way
• Apologetic statement
• Stale remark
• Solicitation of questions
Extra tips !
Items per slide = f (time per slide)
3 slides for 5 mins talk, 50 slides for 60 min.
A picture = A 1000 words
You have to be the master of what you are talking
about.
Don’t have anything on your slide that you don’t
intend to talk about.
A slide is only an aid to the presentation. It is not
for reading
Present it to colleague for critical review….and
prepare the slides well in advance
49
7/23/2018
50
7/23/2018
Objectives
Goals
• A visual presentation of your research.
• Showcase Concise and focused outcomes.
• Explains your research using schematics,
graphs, and other visual strategies, with a
minimum of supporting text.
• Uses various strategies to attract viewers and
stimulate conversation.
51
7/23/2018
• Background- Plain
• Organization- High degree
• Text- Minimum
• Pictures- Optimal
• Graphs/Tables- Large
• Balance- Perfect
Further details….
52
7/23/2018
• Introduction/Summary:
Minimum background information.
Write about your motivation and main breakthroughs.
• Methods and techniques used :
Mention unique feature of your work. For other details,
provide references.
Flow charts, Photos, work well.
• Results:
Biggest section of the poster, with lots of graphs, figures.
Arrange in a logical order so conclusions naturally follow.
53
7/23/2018
Text
• Should be able to read anything from 4’- 6’ away.
• Establish a hierarchy of importance using the font size:
– Title: 80-100 pts
– Subheadings: 40-60 pts
– Body text: 24-30 pts
• AVOID USING ALL CAPS (has the effect of yelling)
• Double-space all text, unless font size is large enough to
read comfortably single-spaced.
• Use shorter sentences.
Editing..
• Use left justification (easier to read).
• Use
– Times New Roman
– Arial
– Calibri
• Be consistent in font type and size
• Use bold, italics, or underline to emphasize words.
– Don’t change fonts to emphasize a word.
– Don’t use all three. Overkill!
• Check your spelling.
54
7/23/2018
Pictures/Images
• JPEG, bitmap, or TIFF formats are easiest to use.
• Stay within 250-300 dpi resolution.
• Use light backgrounds with dark photos and vice
versa.
• Neutral/gray backgrounds enhance color photos
while white backgrounds reduce their impact.
• 4”x5” photos are a good minimum size.
• Fluorescent lighting can change the color.
Graphs/Charts
• Make sure that the text on axes and legends
adhere to the minimum font size.
• Few lines on a graph - label directly.
• Multiple lines on a graph - use a legend.
• Try to make all graphs and figures the same size
for consistency.
• Make lines in the graphs thick enough to see from
4’- 6’ away.
• Use different colors for different groups, and
maintain same color groups throughout poster.
55
7/23/2018
Balance
• Easiest layout involves boxes in 3-5 columns/
rows, are any other geometric shape optimizing
the space and aesthetic features.
• Is one side text- or graph-heavy?
• Use of contrasting or complementary colors.
• Even margins and spaces between boxes?
• General rule of thumb: 20% text, 40% graphics,
and 40% empty space.
• Where does the eye go? Does the poster have
flow?
• Would this poster make you want to stop and
read it?
56
7/23/2018
Poster on preparation….
• Choose a “blank” slide presentation. Open Power-
point and click on “File, New…”
• Go to “File, Page setup…”
– choose custom layout
– choose orientation (usually landscape)
– choose dimensions in inches (36” height maximum)
• Scaling
– May scale poster down by 33% or 50% (change
dimensions accordingly). Then print by doubling or
tripling scale in the print job.
– Actual size (easiest). Everything at 100%. Fonts actual
size on screen. See effect of pixelation on photos.
57
7/23/2018
58
7/23/2018
SUB TITLE
Background:
Acknowledgements:
59
7/23/2018
References
• PhD comics.com
• “Scientists must speak”- 2nd Edn D. Eric Walters and Gale C
Waleters,
CRC Press, Taylor & Francis Group
• “Technical writing- A practical guide for Engineers and
Scientists”, Philipp A laplante, CRC Press, Taylor & Francis
Group
• Research methodology- methods and Techniques- 3rd Edn C R
Kothari and Gaurv Garg, New Age International Publishers,
Practice,
Get Feedback,
Get Better
Work on flow and transition
Success is yours!
60