Technical
Communication
Maiko Arakawa / s1220044
Technical communication
Technical Communication is writing and oral communication for and about
business and industry. Technical Communication takes many different forms.
Table1 gives you examples.
Table1
Written Communication Oral Communication
E-mail Leading meeting
Memo Conducting interview
Letter Making sales call
Report Leaving voice-mail message
Proposal Facilitating training session
Why Technical communication is important?
Technical communication is an important part of you everyday worklife. In
Business, you have many time to communicate with others.
As a supervisor,
you will spend more time to write.
Figure is Time Spent Writing. It
shows that.
Technical Writing
When you write a document, you should consider two things.
Purpose
The Most important thing is purpose. Document provide specific purpose. You
have to tell people this is which you need.
Audience
Document is for particular readers. You should know their level of knowledge,
interest or their problem and make document suited them. You had better to
change the vocabulary, level of detail and writing style for them.
Ethics
Technical Writing need objective analysis and clear presentation. High ethical
standards are important to maintain credibility.
Responsibility
Have a responsibility for your writing. GIve a credit where due. Make all sources
used to write clear.
Correctness
Use correct data. Don’t mislead readers. Emphasis things which is based on the
data.
Fairly
Treat others fairly and respectfully. Something out of scope of the project or
company’s policy isn’t needed.
Good Writing
Good Writing is simple.
Simple means it’s easy to understand for readers. To make writing simple, there
are some points.
❖ Simple sentences
You have some points to be careful to make simple sentences.
❖ Effective trick
You have some trick to make document more understanding.
Simple sentences
For word
Action voice or present tense demonstrates who is responsible for an action
directly. Remove unnecessary words or same words. Use gender-neutral
wording.
For sentences
Split complicated sentences into two simple sentences.
Abbreviation or Acronym
You had better to use abbreviations or terminology. But the first time you use
them, spell it out or define the meaning.
Effective trick
Sidebars
To draw attention. Summary of important information.
Figures and Tables
Instant understanding of complex information.
List
Lists can save readers time. List only comparable items. Parallel structure
throughout. Short sentences, phrases or words.
Cross-reference
To guide the reader to the location. Help reader know when more information
about a topic is available.
Work on a Team
Why teamwork is important?
❏ You can know various angles from member’s diversity of opinion.
❏ Members provide checks and balances by different positions.
❏ Multiple points of view are shared from broad-based understanding.
But team members have different knowledge levels or motives,
so set guidelines and encourage all to participate. It give you success!
Writing with a Team
When you write as a member of a team, you consider two thing.
Know Role
Every team members have different roles. Knowing about your role and other’s
role is important. Especially, project editor should manage whole tasks.
Responsibility is needed for all members.
Outline
Know outline of the entire document or style guide. Documents must be
consistent writing style. Reduce redundancies or contradictions.
Time management
Time management is also important thing when you write something whether
teamwork or not.
Deadline
Make deadline clear. One missed deadline make other missed deadlines.
Check
You need a time to check a document in each step. Especially, final review of
your document. You should get final check from others. You had better to leave
time to verify.
Correspondence & Memoranda
When you write a correspondence or Memoranda,
● Follows standard format
● Discuss only items within the jurisdiction of the organization. Don’t use
personal feelings or opinions.
● Summarize main topics. Make main topics clear.
● Be professional tone throughout.
Letter & E-mail
Letter
❖ Correspondence is public record. It is critical that written communication
be clear and accurate.
❖ Make paragraphs logical for the body of the letter.
❖ Key points is in the final paragraph.
Email
❖ Subject is to what the email is about.
❖ Make the topic and any key information clear and short.
❖ Use proper punctuation and grammar.
Memoranda
When you write a memo, you write them down in each scene.
● Technical Memos
○ Date, summary,
○ Background,
○ Evaluation,
○ Recommendation
● Documenting Memos
○ Title
○ Prepared by
○ Date
○ Re
○ Background
○ Documentation/justification
Figure2 Technical Memo
Figure3 Documenting
Memo
Conclusion
These days, you have to communicate with others by writing or oral in
workplace. For success of business, you need to know Technic of
communication. There are a little difference format depends on tools, however
Technical Writing is useful whenever. When you write document,
● Consider purpose and audience of the document
● Keep ethnic rules
● Know what good writing is
● Keep a deadline
Why technical writing is important for computer science
In Computer science, you study something and report about it. When you tell
something to others, you must make them understood. Audiences are many kind
of people like technical person or not. You must know how to write something.
You should consider about purpose and audience. Depends on them, your
document will change a little. You should know ethnic rule because report is
result of study, not your opinion. You should tell information based on data. Of
course, writing style is important. Even if content is good, bad writing style
doesn’t led people to read. There are standard format each type of document,
you should keep them. Make your document easy to read. Vague or incorrect
words and grammar isn’t reliable. People don’t read unreliable document. When
you study, it is better to do with a team. So, teamwork writing is also important.

Technical Communication

  • 1.
  • 2.
    Technical communication Technical Communicationis writing and oral communication for and about business and industry. Technical Communication takes many different forms. Table1 gives you examples. Table1 Written Communication Oral Communication E-mail Leading meeting Memo Conducting interview Letter Making sales call Report Leaving voice-mail message Proposal Facilitating training session
  • 3.
    Why Technical communicationis important? Technical communication is an important part of you everyday worklife. In Business, you have many time to communicate with others. As a supervisor, you will spend more time to write. Figure is Time Spent Writing. It shows that.
  • 4.
    Technical Writing When youwrite a document, you should consider two things. Purpose The Most important thing is purpose. Document provide specific purpose. You have to tell people this is which you need. Audience Document is for particular readers. You should know their level of knowledge, interest or their problem and make document suited them. You had better to change the vocabulary, level of detail and writing style for them.
  • 5.
    Ethics Technical Writing needobjective analysis and clear presentation. High ethical standards are important to maintain credibility. Responsibility Have a responsibility for your writing. GIve a credit where due. Make all sources used to write clear. Correctness Use correct data. Don’t mislead readers. Emphasis things which is based on the data. Fairly Treat others fairly and respectfully. Something out of scope of the project or company’s policy isn’t needed.
  • 6.
    Good Writing Good Writingis simple. Simple means it’s easy to understand for readers. To make writing simple, there are some points. ❖ Simple sentences You have some points to be careful to make simple sentences. ❖ Effective trick You have some trick to make document more understanding.
  • 7.
    Simple sentences For word Actionvoice or present tense demonstrates who is responsible for an action directly. Remove unnecessary words or same words. Use gender-neutral wording. For sentences Split complicated sentences into two simple sentences. Abbreviation or Acronym You had better to use abbreviations or terminology. But the first time you use them, spell it out or define the meaning.
  • 8.
    Effective trick Sidebars To drawattention. Summary of important information. Figures and Tables Instant understanding of complex information. List Lists can save readers time. List only comparable items. Parallel structure throughout. Short sentences, phrases or words. Cross-reference To guide the reader to the location. Help reader know when more information about a topic is available.
  • 9.
    Work on aTeam Why teamwork is important? ❏ You can know various angles from member’s diversity of opinion. ❏ Members provide checks and balances by different positions. ❏ Multiple points of view are shared from broad-based understanding. But team members have different knowledge levels or motives, so set guidelines and encourage all to participate. It give you success!
  • 10.
    Writing with aTeam When you write as a member of a team, you consider two thing. Know Role Every team members have different roles. Knowing about your role and other’s role is important. Especially, project editor should manage whole tasks. Responsibility is needed for all members. Outline Know outline of the entire document or style guide. Documents must be consistent writing style. Reduce redundancies or contradictions.
  • 11.
    Time management Time managementis also important thing when you write something whether teamwork or not. Deadline Make deadline clear. One missed deadline make other missed deadlines. Check You need a time to check a document in each step. Especially, final review of your document. You should get final check from others. You had better to leave time to verify.
  • 12.
    Correspondence & Memoranda Whenyou write a correspondence or Memoranda, ● Follows standard format ● Discuss only items within the jurisdiction of the organization. Don’t use personal feelings or opinions. ● Summarize main topics. Make main topics clear. ● Be professional tone throughout.
  • 13.
    Letter & E-mail Letter ❖Correspondence is public record. It is critical that written communication be clear and accurate. ❖ Make paragraphs logical for the body of the letter. ❖ Key points is in the final paragraph. Email ❖ Subject is to what the email is about. ❖ Make the topic and any key information clear and short. ❖ Use proper punctuation and grammar.
  • 14.
    Memoranda When you writea memo, you write them down in each scene. ● Technical Memos ○ Date, summary, ○ Background, ○ Evaluation, ○ Recommendation ● Documenting Memos ○ Title ○ Prepared by ○ Date ○ Re ○ Background ○ Documentation/justification Figure2 Technical Memo Figure3 Documenting Memo
  • 15.
    Conclusion These days, youhave to communicate with others by writing or oral in workplace. For success of business, you need to know Technic of communication. There are a little difference format depends on tools, however Technical Writing is useful whenever. When you write document, ● Consider purpose and audience of the document ● Keep ethnic rules ● Know what good writing is ● Keep a deadline
  • 16.
    Why technical writingis important for computer science In Computer science, you study something and report about it. When you tell something to others, you must make them understood. Audiences are many kind of people like technical person or not. You must know how to write something. You should consider about purpose and audience. Depends on them, your document will change a little. You should know ethnic rule because report is result of study, not your opinion. You should tell information based on data. Of course, writing style is important. Even if content is good, bad writing style doesn’t led people to read. There are standard format each type of document, you should keep them. Make your document easy to read. Vague or incorrect words and grammar isn’t reliable. People don’t read unreliable document. When you study, it is better to do with a team. So, teamwork writing is also important.