Professional Documents
Culture Documents
Conclusion--describes expected
results.
Ethics of writing.
Before starting to write your text, report, essay, or Ethics is a set of rules and standards for using
paper do not forget to consider ethics of writing. communication skills and resources when writing a
technical document.
• before starting to report or analyze your technical
work remember you must be correct and honest
in your work.
HONESTY VS PLAGIARIS
M
Print-on Paper Resources
Non-print Resources
Put in Quotations everything that directly comes from the text.
Quoting … “
”
Example:
According to Peter S. Pritchard is USA Today, “Public schools need
reform but they’re irreplaceable in teaching all the nation’s young” (cite)
Paraphrasing
What makes writing not effective?
◦ Grammar mistakes.
◦ Vocabulary mistakes.
◦ Spelling mistakes.
◦ Mechanics and punctuation mistakes.
◦ Sentence errors.
◦ Pattern errors.
Check tools
◦ Thankfully, today’s technology makes memo, letter and proposal writing much easier by
providing reliable tools that check and even correct misspelled words and incorrect grammar
use. Unfortunately, these tools are not fail proof and will require your support, making your
knowledge in this area important.
How to improve your
writing skills?
Write - Write simply and concisely 2) What reaction can I expect from my reader?
The goal of the writing process is to generate a clear, effective document for an audience.
◦ The AUDIENCE is the person or people who will read your document. The more you
clarify who they are, the better you can write to them. You should ask these questions
about your audience:
1. Who will read this document?
2. How much do they know about the topic?
3. Why do they need the document?
4. What will they do with it or because of it?
What is my goal in this situation?
Decide why you are writing this communication
01 02 03
Many Technical Writing If you know what is Knowing what is expected to
documents require a expected, you have a place to write makes document easier
particular final form. start. to write because you know
which information to include
and where to place it.
As you begin to think about drafting,
you should first construct a preliminary
outline.
What Format
and Visual It is important to select a format
and choose visual aids that will
Aids shall I help and not hinder your message.
Use?
The two basic format elements are
margins and heads. (Headings)
Unfortunately,
As you begin to tone isn’t a very
draft, you must objective term. It
consider the tone means what the
of your document. writing sound
What tone
like?
Sift through your analysis and discard any information that does
Sift through not address your purpose
Prepare rough tables, graphs, and other analyses that aid the
Prepare development of your purpose
2- The Writing: Stage
WRITE as
continuously as Drafting and Revising
possible in
comfortable In the writing stage you produce draft.
surroundings
You try to put on paper the words that explain the ideas
in your outline.
Drafting (con’t)
◦ Revise sentences so they are clear to reader (Read out loud) .
◦ Revise paragraphs so they are clear, concise, correct and reliable.
◦ Reorganize sentences if needed.
◦ Rework for deductive order – definitions and overviews first, details
second.
3 – The ◦ In Postwriting, the last stage in the process, you craft the
document into a product that effectively guides your reader
Character of Style:
- Calm, restricted tone, regardless of formality
- Active voice
- Integrated use of illustrations, graphs, charts, tables
- Well-defined abbreviation and symbols
Coherent Logical connection ideas
Coordinated Ideas in logical order
◦ •Planning Planning/
Writing
◦ •Clarity Rethinking
◦ •Brevity
◦ •Simplicity
◦ •Word Choice Revising
◦ •Active Voice
◦ •Committing to Writing as a Process
Clarity: Avoid Jargon Clarity: Define the Unfamiliar
◦ •If you must abbreviate, define the term in its first occurrence,
◦ •Jargon: a vocabulary particular to a place and put abbreviations in parentheses
of work (abbreviations, slang)
◦ •Audience familiarity with the topic
◦ Ex: We know that the use of square-root raised cosine (SRRC)
determines appropriate use of jargon
pulses at transmitter and receiver suppresses inter-symbol
◦ Ex. 1: For the first year, the links with interference (ISI) and maximizes the received signal-to-noise
SDPC and the HAC were not connected, ratio (SNR) in the presence of white noise
and all required OCS input data were
artificially loaded. Thus CATCH22 and
MERWIN were not available. ◦ •Italicize first occurrence of unfamiliar terms and define
◦ Ex. 2: Because some of the links in the them right away
computer system were not connected the ◦
first year, we could not run all the ◦ Ex: In computing, a datawarehouse, also known as an
software codes. enterprise data warehouse, is a system used for reporting and
data analysis, and is considered a core component of business
intelligence
Brevity: Use Words Efficiently Brevity: Less Is More
◦ •Never use two words when one word will ◦ • Pare your language down to the essential
do. message you want to get across to your readers:
◦ Ex. 2: Water quality in Hawk River ◦ Ex. 3: The challenge as never before is capacity
declined in March because heavy rainfalls and boost network performance despite the fast-
overloaded Tomlin County water treatment moving 5G is deployed.
plant.
Simplicity: Use Details Wisely
◦ •Specific details are desirable, but be careful to balance detail with audience needs for clarity—
significance is more important.
◦ Ex. 1: This paper presents an approach to the evaluation of the reverse link capacity of a CDMA cellular voice in
Erlang.
◦ Ex. 2: This paper presents an approach to the evaluation of the reverse link capacity of a CDMA cellular voice
in Erlang, which is a dimensionless unit used in telephony as a measure of offered load or carried load on
service-providing elements [Roger L., 2005]. A single cord circuit has the capacity to be used for 60 minutes in
one hour, full utilization of that capacity, 60 minutes of traffic, constitutes 1 Erlang.
◦ •Many engineers want to provide as much specific detail as possible, but this can come at the
expense of readers understanding and their main point
◦ Ex. 1: The global volume of SMS are increasing enormously. It was 997,668,775,324 messages in 2005
and it is expected to grow three times as much by 2012.
◦ Ex. 2: The global volume of SMS is grown enormously. It was nearly 1 trillion messages in 2005
and it is expected to grow three times as much by 2012.
Language:
Needless Complexity Abstraction
◦ •Avoid too many abstract nouns
◦ Ex. 1: As AI greatly enhances work flow, processes, and accelerates the smart workplace investments, we see particularly
substantial impacts in the Medical and Bioinformatics as well as Financial Services segments.
◦ Ex. 2: We see particularly substantial impacts in the Medical and Bioinformatics as well as Financial Services
segments as AI greatly enhances work flow, processes, and accelerates the smart workplace investments.
◦ •Do not overuse pronouns —particularly “it” and “this”— because it is often difficult to identify the antecedent
◦ Ex.1: The PSM does not describe the channel as in the GBSM but it uses the channel parameters described the
transmission paths
◦ Ex.2: The PSM does not describe the channel as in the GBSM. Instead, the PSM uses the channel parameters
described the transmission paths
Language: Weak vs. Strong
•Avoid too many “to be”verbs: “is”,“was”, “were”,“has been”,“have been”
Adequate content:
Form: marked by using Length 50 to 250
indentations. words, 2-16 sentence.
Adequate development.
Present the
Define the
thesis The closing paragraph:
background.
statement. ◦ Restates thesis + conclusion.
or
State purpose Present the text ◦ Discusses significance + implications.
or scope. contents. or
◦ May call for actions or recommendations.
Transitional paragraphs Body paragraphs
Body paragraphs carry the message of the
text which is usually called a thesis
statement.
•Good writing •Learning and •There are no First •Plan your •Understand •Good
doesn’t happen improvement shortcuts; Draft/Revised project before basic qualities writing is a
overnight; it requires self- Draft/Final Draft you begin of good habit that
requires review, peer- drafting. technical takes time to
planning, review, subject- writing; use the develop;
drafting, matter expert examples practice
rereading, feedback, and presented to makes
revising, and practice. guide you in perfect.
editing. your writing
and revising
process.
Unity is disturbed by grammatical and sentence Cohesion is achieved through maintaining a clear
NOTE pattern, and using specific transition elements within
mistakes as well as unrelated thoughts
and between the sentences
Content:
◦ I. General of Technical Writing
◦ II. Technical Writing Process
◦ III. Structure
◦ IV. Plagiarism
IV. PLAGIARISM
Doing research puts you in a position to present views
relevant to your topic other than your own.
Plagiarism
Steals Ideas You will discover many interesting ideas. But be sure
you keep track of which ideas are your own and which
What is You must cite your sources correctly and give credit to
plagiarism?
others where it is due. That honesty in dealings regarding
your coursework is known as academic integrity.
As well as stating the important points Very short parts of a source text (e.g. part of a
you should also explain the points. By sentence) can be copied when needed.
doing this you go beyond merely However, the words that you have copied
repeating the information which you must be immediately obvious to your reader.
have found. This is what makes a good You must also take care not to change any of
assignment the words.
2. Question: What if you paraphrased someone else’s work and didn’t give it credit. Is this
plagiarism?
Answer: Yes
3. Question: What if you find a picture on the web that would look good in your paper and copy and
paste it into your paper. Is that plagiarism?
Answer: Yes
5. Question: If you used Thomas Jefferson's exact words from some document he wrote, and didn't
give credit, would that be plagiarism?
Answer: Yes