Introduction To The Course
Introduction To The Course
TO THE COURSE
Course: Technical and Business Writing
Course code: HU-212
• As a Specialist
you need to generate ideas which will be potentially useful.
• To share results
share the results of your ideas with co-workers, customers, etc. as a
communicator
• Writing is critical to your success.
• Besides enabling you to do your job, writing well can bring you
many personal benefits as well:
• Instruction manuals
Instructional writing provides step-by-step instructions to perform specific
tasks or operations. Examples include user guides, assembly manuals, and
operating procedures.
Links to sample instruction manuals and other examples of types of
technical writing from an online writing textbook.
Online Technical Writing: Examples, Cases & Models
https://mcmassociates.io/textbook/examples/instruxx5b.pdf
• Proposals
A technical proposal is a type of document that outlines the precise details of
a proposed product or service.
This document may contain any of the following: Technical requirements.
Design considerations. Functional specifications.
https
://learning.candid.org/resources/sample-documents/?tab=tab-fullproposals
Share Samples
• Reports
Report writing involves presenting findings, analysis, and conclusions
based on research or investigations. Technical reports are commonly used
in scientific and engineering fields.
(Can include progress, problem-solving, feasibility, laboratory,
research, and recommendation reports.)
https://instr.iastate.libguides.com/c.php?g=284553&p=1948068
• Posters and Visual communication
https://betterposters.blogspot.com/search/label/critiques
• Technical descriptions
https://support.apple.com/kb/SP894?viewlocale=en_US&locale=en_US
• Product recalls
https://www.cpsc.gov/Recalls
https://www.recalls.gov/recent.html
• White papers
A white paper is a research-based report which offers a focused description of a
complex topic and presents the point of view of the author or body represented
by the author. The purpose of a white paper is to give readers understanding of
an issue, which in turn helps them solve a problem or make a decision. Mostly
used for marketing and promotion.
https://www.egain.com/knowledge-management-white-papers/
Mechanics of Technical Writing
The mechanics of technical writing encompass the essential elements and
practices that contribute to effective communication in technical
documents. These mechanics ensure clarity, accuracy, and readability in
conveying complex information. Key aspects of the mechanics of
technical writing include:
Write down the ideas or points you want to cover. This helps
you get started in identifying the key ideas you want to discuss.
Importance
Begin with the most important piece of information and then move
on to the next most important.
Chronological order
Describe what happened first, second, third.
Problem-Solution
Define the problem, then describe possible alternatives or the
solution you recommend.
Question-Answer
State a question and then provide your answer. Organize your
ideas so the reader can easily follow your argument or the
point you are trying to get across.
4. Back it up
There are a number of ways you can support your ideas, including
explanations, examples, facts, personal experiences, stories,
statistics, and quotations.
When using numbers in the body of your paper, spell out numbers
one through nine, such as "Three men decided…"
There are several web sites that can help you improve your
writing.
These websites can help you with spelling and making sure you're
using the word correctly, and also has links to lots of other
resources.
Summary
Try to be simple, clear, and brief. Like any skill, "good writing"
requires practice, feedback, and ongoing improvement.