59
TECHNICAL WRITING November 14 th , 2012

TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Embed Size (px)

DESCRIPTION

Short report Also known as “informal” or “semiformal” report. A short report is an organized presentation of relevant info/data on any topic.

Citation preview

Page 1: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

TECHNICAL WRITINGNovember 14th , 2012

Page 2: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

TodayShort Reports: Proposals (Internal Proposals).

Page 3: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Short reportAlso known as “informal” or “semiformal” report.

A short report is an organized presentation of relevant info/data on any topic.

Page 4: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Types of Short ReportsThe six most common types of short reports are:

1. Periodic reports. Provide readers with information at regularly scheduled intervals.

2. Sales reports. Provide businesses with financial and managerial information.

3. Progress reports. Inform readers about the status of ongoing projects.

4. Travel reports. Document business trips and how they affect ongoing or future business.

5. Incident reports. Outline unexpected events that interfere or threaten normal, safe business operations.

6. Proposals. Details a plan of action that is submitted to a reader for approval.

Page 5: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

1. Anticipate how the audience will use your report.

Consider how much your audience knows about your project and what types of information they most need.

Page 6: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

2. Do the necessary research.

Take careful notes, record all necessary background information, collect relevant factual data, and interview key individuals.

Page 7: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

3. Be objective and ethical.

Avoid guesswork, do not substitute impressions or unsupported personal opinions for careful research, avoid biased/skewed/incomplete data, and double check all facts/figures/specifications.

Page 8: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

4. Organize carefully.

Include a purpose statement, findings, a conclusion, and recommendations.

Page 9: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

5. Use reader-centered headings, bullets, numbering, and visuals.

Help readers locate and focus on key information in your report.

Page 10: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

6. Write clearly and concisely. Use an informative title/subject that gets to the point right awayWrite in plain EnglishUse a professional yet personal toneDo not include unnecessary background information.

Page 11: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines to writing short reports (simplified)

7. Use appropriate format and visuals. Make your report look professional, readable, and easy to follow; help readers locate and digest information quickly; be consistent in your design and format; include only the most essential visuals; and design, import, and place visuals appropriately.

Page 12: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

ProposalsA proposal is a detailed plan of action that is submitted to a reader (or group of readers) for approval.

These readers are usually in a position of authority (supervisors, managers, etc.).

They are able to endorse or reject the proposal.

Page 13: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

ProposalsThe purpose of the proposal:

Convince the readers that your plan will be beneficial:

i.e., - Improve business. - Save money. - Enhance a company’s image. - Improve customer satisfaction. - Improve working conditions.

Your plan may do one of these, or a combination.

Page 14: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

ProposalsAs you can guess, proposals are written for many purposes and many different audiences.

i.e.,

An internal proposal to your boss seeking authorization to hire staff or purchase new equipment.

A sales proposal to potential customers, offering a product or service.

Page 15: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

ProposalsProposals can vary greatly in size and scope.

- A formal proposal can be very long (100+pages) and complex.

- An internal proposal to your employer, though, can be accomplished in a 2 or 3 page memo (sometimes shorter).

i.e., A proposal for a new business district development project

vs.

redecorating the waiting room at a doctor’s office.

Page 16: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Proposals are Persuasive PlansTo succeed, proposals must be highly persuasive.

Enthusiasm is not enough.

“We really, really, really wanna hire a new assistant for the IB department. It will make work much easier!”

- Is not persuasive.

Hard evidence is required to be persuasive.

Page 17: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Proposals are Persuasive Plans“We really, really, really wanna hire a new assistant for the IB department. It will make work much easier!”

- Hard evidence is required to be persuasive.

Examples?

-Currently only one IB assistant. - Assistant is overworked (works 10 hours overtime/week). - Not able to assist all faculty members. - Work moves slowly (currently can take more than 1 day to get assistance). - Hiring an additional assistant will increase efficiency of assistance. - Will save time and increase job satisfaction for both administrative staff and faculty members.

Page 18: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Proposals are Persuasive PlansProposals must convince readers that the plan is:

- Relevant.

- Practical.

- Based upon careful research.

- Designed to help the reader and his/her organization.

Page 19: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Proposals are Persuasive PlansProposals require a “can do” attitude.

The tone should be:

“Here is what I can do for you.”

“This is how my plan will help you.”

Page 20: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals1. Approach a proposal as a problem-solving activity.

Your purpose should reflect your ability to identify and solve problems.

Convince the audience you know what their needs are and that you will meet them professionally, safely, and promptly.

Page 21: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals2. Regard your audience as skeptical.

Even if you KNOW your proposal will benefit the readers, don’t be over confident.

Brainstorm to anticipate readers’ questions and objections.

Remember : Your readers will study your proposal carefully.

i.e., A proposal to hire a new IB assistant.

Page 22: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals3. *Research your proposal topic thoroughly*

Successful proposals are not based on a few general suggestions.

- “Hiring a new IB assistant would be great. It will save time and the current assistant won’t be lonely. Come on. Hire a new assistant!”

Page 23: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals3. *Research your proposal topic thoroughly*

You have to know and provide detailed information to be convincing.

Research the topic: - study the latest technology in the field. - shop for the best prices. - compare prices and services with competitors. - visit customers. - interview key people.

Page 24: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals4. Scout out what your competitors are doing.

Become familiar with competitors’ products or services.

Be able to show that your company’s work is better overall.

Provide examples or offer a demonstration:

- “Yonsei’s IB department has several assistants and their department runs much more efficiently (takes only 1 hour to receive assistance and has 40% higher work satisfaction.”

Page 25: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals5. Prove your proposal is doable.

What you propose should be consistent with the organization and capabilities of the company.

i.e., Telling a small college like KAC to hire 25 new assistants would be ridiculous.

Avoid the phrases like this:

- “Let’s see what happens.” - “Hopefully this will work.” - “This plan might help.”

Page 26: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals6. Be sure your proposal is financially realistic

The biggest question asked of your proposal will be:

“Is it worth the money?”

Prepare a cost estimate based on research (market conditions, competitors’ prices, your reader’s budget.

i.e. Recommending that your company spend $30,000 to solve a $3,000 problem is a poor idea.

Page 27: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals6. Be sure your proposal is financially realistic

The biggest question asked of your proposal will be:

“Is it worth the money?”

Above all, convince the readers that the benefits are worth the cost.

i.e., Hiring a new IB assistant.

Page 28: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Guidelines for Successful Proposals7. Package your proposal attractively.

Make sure it is well presented, professional looking, attractive, and easy to read.

Make sure any visuals are clear and appropriately placed.

The visual appearance of your proposal can influence whether it gets accepted.

Page 29: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)
Page 30: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Internal ProposalsPurpose:

Offer a realistic and constructive plan to help your organization run its business more efficiently (and economically).

Page 31: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Internal ProposalsGenerally, internal proposals are written as a 1 – 3 page memo.

Page 32: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Internal Proposals – Common Topics- Purchasing new or more advanced equipment to replace

current equipment.

- Recruiting new employees or retraining current ones.

- Eliminating a dangerous condition or reducing an environmental risk to prevent accidents.

- Cutting costs.

- Improving something (services, communications, efficiency).

Page 33: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Organizing Internal ProposalsLook at the sample proposal.

What do you notice about its organization?

What sections do you see?

Page 34: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Organizing Internal ProposalsMain Sections:

The Purpose

The Problem

The Solution or Plan

The Conclusion

Page 35: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Memo format

Clear subject

Clearly states why proposal is being sent

Takes into account organization’s mission

Identifies problem by giving reader essential background information based on research

Provides easy-to-read table

Page 36: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Divides problem into parts- volume, financial, personnel, customer service

Emphasizes the cost if nothing is done

Cites important research

Verifies that the problem is widespread

Relates solution to individual parts of the problem

Bullet points make recommendations easy to read and follow

Page 37: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Shows problem can be solved and stresses how

Photo shows location has room for additional ATM

Documents that work can be done on time and highlights advantage of doing it now

Itemizes costs

Page 38: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Interprets cost for reader

Prove change is cost-effective, citing specific financial evidence

Ends by stressing benefits for reader and bank as a whole

Finishes by thanking reader

Page 39: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The PurposeBegin purpose with a brief statement of why you are writing to you supervisor:

“I propose that…”

- State immediately why you think a specific change is necessary now.

- Then, define the problem and emphasize that your plan (if approved) will solve that problem.

Page 40: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemProve that a problem exists.

Document its importance for your boss and organization.

- The more you show (with evidence) how the problem affects the boss’s work, the more persuasive you will be.

Page 41: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemAvoid vague generalizations:

“We’re losing money each day with this piece of equipment.”

“Costs continue to increase.”

“Numerous complaints have come in.”

“If something isn’t done soon, more problems will result.”

“Our building will explode!!”

Page 42: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemProvide quantifiable details about the problem: - The amount of money or time the company is losing per day, week, or month.

- The number of accidents that occur each year due to an unsafe procedure.

Documenting these details allows you to show (in the next section) how your plan offers an efficient, workable solution.

Page 43: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemIndicate how many employees (or work hours) are involved.

How many customers are inconvenienced or endangered by a procedure.

See the table in our sample.

Page 44: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemVerify how widespread or frequent the problem is by citing specific occasions.

In the sample: provide evidence from the Watson-Perry, Inc. survey AND from interviews with Rachel Harris-Kyoto.

Page 45: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ProblemRelate the problem to the organization’s image, corporate mission, or influence.

- Show exactly how and where the problem lessens your organization’s effectiveness or hurts its image.

- - Who - How

- In the sample: Indicates how the problem hurt’s the company’s image.

Page 46: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanDescribe how you will make your proposed change and demonstrate the likelihood of success.

- The reader will again expect factual evidence.

Page 47: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanBe specific. Supply details to answer:

1) Is the plan doable, possible? - Can it be accomplished here?

2) Is it cost-effective? - Will it really save us money in the long run?

Page 48: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanProvide factual evidence you have gathered as a result of your research.

i.e., if you propose that your firm buy a new piece of equipment, locate the most efficient and cost-effective model available (like our example).

- Supply dealer’s name, costs, installation time, necessary service and training contracts, warranties.

- Describe how the firm can use the equipment to obtain better or quicker results in the future.

- Document specific tasks the new equipment can perform more efficiently than the models you use now.

Page 49: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanIf the proposal is to change a procedure, it must address:

- How does the new procedure work?- How many employees or customers will be affected?- When will it go into operation (begin)?- How much will it cost us to change procedures or add new

equipment, services, or staff?- What delays or losses in business might be expected

while we switch procedures?- What employees, equipment, or locations are already

available to accomplish the change?

Page 50: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanRemember:

COSTS will be the most important thing on the mind of the decision-making reader.

Make sure to provide a careful and accurate budget.

ALSO:

Make the costs attractive by emphasizing how inexpensive they are compared to the cost of NOT making the change.

Page 51: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanLink costs to savings and other benefits.

Sample: States that the initial cost, though higher than that for a new employee, actually saves money in the long run.

Page 52: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Solution or PlanIt is also good to mention alternative solutions (before the reader does), and discuss their disadvantages..

In our sample: Shows why installing an ATM is better than hiring a fifth bank teller.

Page 53: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ConclusionShould be short (one paragraph, two at the very most).

Remind readers that:

a) the problem is ongoing and serious.

b) the reason for change is justified and will benefit your organization.

c) action needs to be taken and by a specified time.

Re-emphasize the most important advantages.

Page 54: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The Conclusion--> Our sample: - Stresses the savings the bank will see by following the proposed plan.

- Also mentions increase in customer satisfaction.

Page 55: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

The ConclusionEnd by:

- indicating that you are willing to discuss your plan with the reader and seek his/her input.

- Thank the reader(s) for considering your proposal.

Page 56: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

THE END

Page 57: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Assignment 6Write an internal proposal, recommending Keimyung University to:

a) Hire more faculty, student workers, or office help.

b) Increase the number of online classes in your major.

c) Open a new, health conscious cafeteria on campus.

d) Purchase new classroom equipment or software.

e) Train employers about discrimination (i.e., race, age, sex, culture, looks, etc.)

Page 58: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Assignment 6Your role: A KMU administrator (not a student).

Obviously, you will have to do some “research”.

i.e., you may have to create some data.

You can do actual research where feasible.

If you have any trouble with your data, let me know.

Page 59: TECHNICAL WRITING November 14 th, 2012. Today Short Reports: Proposals (Internal Proposals)

Assignment 6Important:

- Brainstorm and do “research” with a partner.

BUT

- Write your own proposal!

First Draft Due: Monday November 19th

Subject: proposal draft