technical report writing dr. shelley thomas. overview selecting effective report topics using...

20
Technical Report Writing Dr. Shelley Thomas

Upload: matilda-osborne

Post on 26-Dec-2015

214 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Technical Report WritingTechnical Report Writing

Dr. Shelley Thomas Dr. Shelley Thomas

Page 2: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

OverviewOverview

• Selecting effective report topics• Using worksheets to plan projects• Developing and proposing project

plans• Developing effective report drafts• Revising drafts

• Selecting effective report topics• Using worksheets to plan projects• Developing and proposing project

plans• Developing effective report drafts• Revising drafts

Page 3: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

3-Parts of Report Writing 3-Parts of Report Writing • Part 1: Proposal• plan and propose project to instructor

• Part 2: First draft of report• conduct research and interpret findings• develop and design visual and textual content

• Part 3: Revise and add formal elements• revise draft (style, cohesion, and usage) for

situation and audiences• develop front and back matter

• Part 1: Proposal• plan and propose project to instructor

• Part 2: First draft of report• conduct research and interpret findings• develop and design visual and textual content

• Part 3: Revise and add formal elements• revise draft (style, cohesion, and usage) for

situation and audiences• develop front and back matter

Page 4: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Report TopicsReport Topics

• Students must identify• a real client who• has a problem, need, or opportunity• has decision-making authority• is available to meet face to face (at

least twice)

• Students must identify• a real client who• has a problem, need, or opportunity• has decision-making authority• is available to meet face to face (at

least twice)

Page 5: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Report TopicsReport Topics• An investigative focus on determining

whether a solution is feasible.• Investigates whether X is a feasible

solution to the client’s problem. Makes a recommendation to implement or not implement X.

• Investigates whether Y or Z is a more feasible solution to the client’s problem. Makes a recommendation to implement Y, Z, or neither.

• An investigative focus on determining whether a solution is feasible.• Investigates whether X is a feasible

solution to the client’s problem. Makes a recommendation to implement or not implement X.

• Investigates whether Y or Z is a more feasible solution to the client’s problem. Makes a recommendation to implement Y, Z, or neither.

Page 6: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Report TopicsReport Topics

• An investigative focus on understanding a problem and identifying a plan of action for solving it.• Investigates why X occurred (or is

occurring). Recommends a plan of action for resolving X.

• An investigative focus on understanding a problem and identifying a plan of action for solving it.• Investigates why X occurred (or is

occurring). Recommends a plan of action for resolving X.

Page 7: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Report TopicsReport Topics• An investigative focus on convincing a

client to implement a particular solution to solve a problem (or realize an opportunity). • Proposes that the client authorize the

writer to implement solution X, which will solve the client’s problem.

• Proposes that the client consider an alternate method, procedure, or product for meeting an existing need.

• An investigative focus on convincing a client to implement a particular solution to solve a problem (or realize an opportunity). • Proposes that the client authorize the

writer to implement solution X, which will solve the client’s problem.

• Proposes that the client consider an alternate method, procedure, or product for meeting an existing need.

Page 8: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Questions?Questions?

• Suggested Topics• Suggested Topics

Page 9: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Purpose: to help students • create a realistic plan for researching

and developing their report• test the suitability of the topic• create a framework or research plan

that will guide • their investigative efforts • their interpretive acts

• Purpose: to help students • create a realistic plan for researching

and developing their report• test the suitability of the topic• create a framework or research plan

that will guide • their investigative efforts • their interpretive acts

Page 10: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Worksheet 1 : Problem and Solution Analysis• Analyzing problem • Identifying goals and criteria for

effective solutions• Forecasting possible solutions

• Worksheet 1 : Problem and Solution Analysis• Analyzing problem • Identifying goals and criteria for

effective solutions• Forecasting possible solutions

Page 11: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Problem Analysis• Problem statement• Workplace context• Systems context• Negative consequences• Potential causes• Remedies in progress

• Problem Analysis• Problem statement• Workplace context• Systems context• Negative consequences• Potential causes• Remedies in progress

Page 12: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Criteria for Effective Solution(s)• Goals solution(s) should achieve• Criteria for evaluating solution(s)• Conditions constraining solution(s)

• Criteria for Effective Solution(s)• Goals solution(s) should achieve• Criteria for evaluating solution(s)• Conditions constraining solution(s)

Page 13: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Solution Analysis• How the solution solves the problem• Negative consequences eliminated• Positive consequences added• How the solution compares to other

solutions (possibly, how the solution compares to doing nothing)

• Solution Analysis• How the solution solves the problem• Negative consequences eliminated• Positive consequences added• How the solution compares to other

solutions (possibly, how the solution compares to doing nothing)

Page 14: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Worksheet 2: Audience Analysis• Identifying audience groups• Analyzing audience characteristics

• Worksheet 2: Audience Analysis• Identifying audience groups• Analyzing audience characteristics

Page 15: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Identifying audience groups• primary, secondary, tertiary • tangential or chance

• Identifying audience groups• primary, secondary, tertiary • tangential or chance

Page 16: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Analyzing audience characteristics• level of knowledge, experience• point of view (purpose, concerns)• attitude and motivation• learning needs and learning styles• expectations and assumptions

• Analyzing audience characteristics• level of knowledge, experience• point of view (purpose, concerns)• attitude and motivation• learning needs and learning styles• expectations and assumptions

Page 17: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Worksheet 3: Research Plan• Have identified

• problem and solution(s) to be analyzed• context for the problem• audience groups for report• goals and criteria for evaluating the

solution(s)

• Need a rigorous method or research plan

• Worksheet 3: Research Plan• Have identified

• problem and solution(s) to be analyzed• context for the problem• audience groups for report• goals and criteria for evaluating the

solution(s)

• Need a rigorous method or research plan

Page 18: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Planning Worksheets

Project Planning Worksheets

• Worksheet 3: Research Plan• For each criterion identified,

• identify required information (background information about criterion and information about solution in light of the criterion)

• select methods for collecting information (observation, interviews, interaction w/system, review of literature or artifacts, questionnaires and surveys)

• list resources available

• Worksheet 3: Research Plan• For each criterion identified,

• identify required information (background information about criterion and information about solution in light of the criterion)

• select methods for collecting information (observation, interviews, interaction w/system, review of literature or artifacts, questionnaires and surveys)

• list resources available

Page 19: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

Project Plan Proposals Project Plan Proposals • Students propose their project plan to the

instructor. • Students must convince the instructor that

they• understand the client’s problem• have identified appropriate criteria or goals for

a successful solution• have developed a feasible schedule of activities• are qualified to perform this investigation and

analysis

• Students propose their project plan to the instructor.

• Students must convince the instructor that they• understand the client’s problem• have identified appropriate criteria or goals for

a successful solution• have developed a feasible schedule of activities• are qualified to perform this investigation and

analysis

Page 20: Technical Report Writing Dr. Shelley Thomas. Overview Selecting effective report topics Using worksheets to plan projects Developing and proposing project

DraftsDrafts

• Students draft their work and conference with the instructor before the final version is due.

• Students draft their work and conference with the instructor before the final version is due.