Вы находитесь на странице: 1из 19

BIRLA INSTITUTE OF TECHNOLOGY & SCIENCE, PILANI

WORK INTEGRATED LEARNING PROGRAMMES


Digital Learning
Part A: Course Design

Course Title Technical Report Writing

Course No(s) TA ZC 312

Credit Units 3

Credit Model Flipped Model

Content Authors Geetha KA

Course Objectives

No

CO1 Enrich the skill and competency of students in technical communication

CO2 Developing an integrated and systematic approach involving information gathering,


organizing and presenting

CO3 Practical knowledge of the tools, techniques ethics and etiquette of technical correspondence,
documentation, reports and presentation

CO4 Addressing communication challenges that impact organization through sharing of best
practices and group learning

Text Book(s)

T1 Sharma R.C. and K. Mohan, Business Correspondence and Report Writing, TMH, 4th Ed., 2010.

T2

Reference Book(s) & other resources

R1 Raman Meenakshi and Sangeeta Sharma. Technical Communication. 2nd edition. New Delhi:
Oxford University Press. 2011

R2 Sharon J. Gerson & Steven M. Gerson, Technical Writing Process and Product, Pearson
Education, 5th Ed., 2007.
Content Structure

1. Basics of Professional Communication


1.1. Overview, definition, & importance of technical communication
1.2. The process, levels & flow of communication

2. Communicating effectively
2.1. Non-verbal communication, barriers to communication and principles of effective
communication

3. Principles of effective writing


3.1. Planning- Target audience
3.2. Gathering, evaluating and documenting information
3.3. Language- grammar and vocabulary; punctuation

4. Vocabulary
3.1 Improving vocabulary
3.2 Use of apt words in speech and written documents.
3.5

5. Reading & Review


5.1. Speed
5.2. Critical reading and Note making
5.3. Editing & Proofing

6. E-Mail Etiquettes
6.1 Common errors while drafting a mail
6.2 Writing for International audience

7. Listening & Speaking


7.1. Types of listening, effective listening
7.2. Creative thinking & Speaking

8. Social Media
8.1 Informal communication (work related) through Social media
8.2 Blogs
8.3 Critiquing ideas and work effectively

9. Making Effective Presentations


9.1. Making and delivering effective presentations
9.2. Innovative ways of making a presentation

10. Meetings and Memos


10.1. Effectively managing and participating in meetings-writing minutes
10.2. Agenda, Notices, Memorandums

11. Group Discussion


11.1. Overview and forms of group communication
11.2. Organizational group discussions, Discussions on problems and solutions
11.3. Effectively participating in group discussions

12. Group communication


12.1. Speaking about future plans/annual reports
12.2. Oral instructions

13. Technical Proposals & Transaction Documents


13.1. Objectives, types and characteristics and importance
13.2. Structure, style and appearance

14. Technical Proposals (Part I)


14.1. Proposals
14.2. Expected evaluation scheme

15. Technical reports (Part II)


15.1. Objectives, characteristics, types, forms and formats
15.2. Description- Technical and Process

16. Preparing to write reports


16.1. Specimens-Analytical, Laboratory, Inspection, Progress reports
16.2. Intent, planning & preparation, data collection
16.3. Structure and outline

17. Writing Reports


17.1. Writing the report
17.2. Revising, editing and proofreading

18. Writing Letters-1


18.1. Principles of letter writing
18.2. Types of letters- differences in tone

19. Writing Letters-2


19.1. Claims, adjustment, credit and collection letters
19.2. Responding to complaints

20. Ethics and intellectual property


20.1. Ethics
20.2. Intellectual property- patents documentation
Learning Outcomes:

No. Learning Outcomes

LO1 Understand principles of effective technical communication

LO2 Apply these principles in the creation of various artefacts and processes of technical
communication- both written and oral-- resulting in well designed and well-written and
presentable documents and in effective oral communication

LO3 Be ethical and responsible in communicating.


Part B: Content Development Planning

CD Term Second Semester 2018-2019

Course Title Technical Report Writing

Course No TA ZC 312

Content Developer

Instructor –In-Charge Geetha KA -

Glossary of Terms:

1. Contact Hour (CH) stands for a hour long live session with students conducted either in a
physical classroom or enabled through technology. In this model of instruction, instructor
led sessions will be for 20 CH.
a. Pre CH = Self Learning done prior to a given contact hour
b. During CH = Content to be discussed during the contact hour by the course
instructor
c. Post CH = Self Learning done post the contact hour
2. RL stands for Recorded Lecture or Recorded Lesson. It is presented to the student through
an online portal. A given RL unfolds as a sequences of video segments interleaved with
exercises
3. SS stands for Self-Study to be done as a study of relevant sections from textbooks and
reference books. It could also include study of external resources.
4. LE stands for Lab Exercises
5. HW stands for Home Work will consists could be a selection of problems from the text.

Contact Hour 1 – Basics of Professional Communication

Time Type Sequence Content Reference

Pre CH RL1.1 RL1.1.1 = Overview, definition and Studio lecture


importance of communication

Pre CH RL1.2 RL 1.2.1 = The process, levels and flow of Studio lecture
communication

During CH1 CH1.1 = Summary of studio lectures Case of multinational enterprise


CH CH1.2 = Identify the communication with R&D and manufacturing
needs, levels, flow and types of units
communication

Post CH SS1 SS1.1 = Understanding communication Video case


issues

Post CH HW1 HW1.1 = Become aware of the role of


effective communication in day to day
transactions

Post CH LE1 - -

Post CH QZ1 QZ1.1 = Quiz questions provided by Quiz sheet (to be provided by
instructor instructor)

Notes:

Contact Hour 2 – Communicating Effectively

Time Type Sequence Content Reference

Pre CH RL2.1 RL2.1.1 = Pitfalls of ineffective video


communication Studio lecture
RL2.1.2 = Need for Communication plan Studio lecture

During CH2 CH2.1 = Module overview Instructor to prepare a


CH CH2.2 = Barriers to communication-case study case

Post CH SS2 - -

Post CH HW2 - -

Post CH LE2 - -

Post CH QZ2 QZ2.1 = Quiz questions provided by instructor Quiz sheet (to be
provided by instructor)

Notes:
Contact Hour 3 – Principles of effective writing

Time Type Sequence Content Reference

Pre CH RL3.2 RL 3.1.1 = Planning Studio lecture


RL 3.1.2 = Gathering evaluating and Studio lecture
documenting information
RL 3.1.3 = Language- grammar and Studio lecture
vocabulary, punctuation

During CH3 CH3.1 = Module overview


CH CH3.2 = Writing exercises using different
tenses, bringing out common problems and
mistakes in grammar, word usage and
punctuation
CH3.3 = Discussion on vocabulary and
creation of a strategy to enhance vocabulary

Post CH SS3 - -

Post CH HW3 HW3.1 = Exercise in punctuation


HW3.2 = Readup/Compile a list of commonly
made mistakes from references

Post CH LE3 - -

Post CH QZ3 QZ3.1 = Quiz questions provided by instructor Quiz sheet (to be
provided by instructor)

Notes:

Contact Hour 4 – Document (Writeup) Design and Illustration

Time Type Sequence Content Reference

Pre CH RL4.1 RL4.1.1 = Structure- focus, persuasion, Studio lecture


coherence
RL4.1.2 = Style- tone, clutter, verbs, sentences Studio lecture
RL4.1.3 = Using templates and illustration Studio lecture

During CH4 CH4.1 = Analyse a document for structure,


CH focus and persuasion
CH4.2 = Analyse style of a document to bring
out the distinction of a style suitable for
technical communication
CH4.3 = Discuss specific templates and
method of referencing illustrations
Post CH SS4 - -

Post CH HW4 HW4.1 = Write-up exercise List of write-up exercise


problems

Post CH LE4

Post CH QZ4 QZ4.1 = Quiz questions provided by instructor Quiz sheet (to be provided
by instructor)

Notes:

Contact Hour 5 – Reading & Review

Time Type Sequence Content Reference

Pre CH RL5.1 RL5.1.1 = Methods of quick reading Studio lecture


RL5.1.2 = Critical reading Studio lecture
RL5.1.2 = Introduction to proof reading Studio lecture

During CH5 CH5.1 = Module overview


CH CH5.2 = Exercise in quick reading followed Document for quick and
by questions on the document critical reading.
CH 5.3 = Second reading of document-
critically and critical analysis of it
CH5.4 = Common notations for proof
reading

Post CH SS5 - -

Post CH HW5 HW5.1=Critical reading exercise and Instructor to provide a


answering questions passage for critical reading.

HW5.2=Document to practice proof reading Instructor to provide


document for proofreading-
with a challenge to find the
correct number of issues in
document.

Post CH LE5 - -

Post CH QZ5 QZ5.1 = Quiz questions provided by Quiz sheet with short
instructor reading comprehension
passages (to be provided by
instructor)

Notes:
Contact Hour 6 – The art of condensation

Time Type Sequence Content Reference

Pre CH RL6.1 RL6.1.1 = Introduction to Précis writing Studio lecture


RL6.1.2 = Technique- steps in précis writing Studio lecture

During CH6 CH6.1 = Discussion of a sample précis


CH CH6.2 = Exercise in précis writing

Post CH SS6 -

Post CH HW6 Précis writing exercise Exercise to be


provided

Post CH LE6

Post CH QZ6 - -

Notes:

Contact Hour 7 – Listening & Speaking

Time Type Sequence Content Reference

Pre CH RL7.1 RL7.1.1 = Listening Effectively Studio lecture


RL7.1.2 = Speaking Studio lecture

During CH7 CH7.1 = Module overview


CH CH7.2 = Exercise in listening and answering Audio clip provided
questions based on the audio clip by instructor
CH7.3 = Static method exercise

Post CH SS7 - -

Post CH HW7 HW7.1 = Listening comprehension exercise Audio clip resources


to be provided on
Taxila

Post CH LE7 - -

Post CH QZ7 QZ7.1 = Quiz questions provided by Quiz sheet based on


instructor listening and
speaking etiquette-
e.g. introductions (to
be provided by
instructor)
Contact Hour 8 – Making effective presentations

Time Type Sequence Content Reference

Pre CH RL8.1 RL8.1.1 = The art of making effective Studio lecture


presentations
RL8.1.2 = Making PowerPoint slides the way Studio lecture
they should be made
RL8.1.3= Effectively selling your ideas Studio lecture
through presentation (techniques used by
speakers on TED)

During CH8 CH8.1 = Module overview


CH CH8.2= Interactive Discussion-planning for
the presentation event
CH8.2 = Discuss a sample PowerPoint slide-
the usual one and the ideal PowerPoint slide

Post CH SS8 - -

Post CH HW8 HW8.1 = Listen to 2 presentations in your


interest area on TED.com
HW8.2 = Make a TED talk and present it

Post CH LE8

Post CH QZ8 QZ8.1 = Quiz questions provided by Quiz sheet (to be


instructor provided by
instructor)

Contact Hour 9 – Meetings and Memos

Time Type Sequence Content Reference

Pre CH RL9.1 RL9.1.1 = Organizing meetings Studio lecture


RL9.1.2 = Participating in meetings Studio lecture
RL9.1.3 = Writing minutes, memos and Studio lecture
notices

During CH9 CH9.1 = Overview


CH CH9.2 = Writing an agenda for a meeting
(recording of this proposed meeting to be Recorded Meeting
played for next exercise) Dialogue-I to be
CH9.3 = Exercise on writing minutes of provided by instructor
meeting and played during the
CH9.4= Memos and notices- session.

Post CH SS9 - -
Post CH HW9 HW9.1=Writing MOM -Recorded Meeting
HW9.2=Writing a notice Dialogue-II
HW9.3=Writing a memorandum

Post CH LE9 - -

Post CH QZ9 - -
Contact Hour 10 -Group Discussions

Time Type Sequence Content Reference

Pre CH RL10.1 RL10.1.1 =Introduction to Recorded lecture


Group communication
RL10.1.2 =Participating in Recorded lecture
Organizational group discussion
A recorded group discussion for
discussion during contact hour

During CH10 CH10.1 =Overview


CH CH10.2 =Listening to a group
discussion
CH10.3 =Discussion on the
group discussion using pointed
questions to bring out the best
practices in participation
CH10.4 =Summarization of a
group discussion.

Post CH SS10 - -

Post CH HW10 -Organize and participate in a


group discussion on an
organizational problem which
is important

Post CH LE10 - -

Post CH QZ10 - -

Notes:
Contact Hour 11- Group Communication

Time Type Sequence Content Reference

Pre CH RL11.1 RL11.1.1 =Speaking about Recorded lecture


future plans/annual reports
RL11.1.2 =Effectiveness in Oral
Instructions to Group Recorded lecture

During CH11 CH11.1 =Overview


CH CH11.2 =Listening to a sample
speech and interactive Audio of sample speech
discussion of the effectiveness
CH11.3 =Preparing to deliver
oral instructions in a specific Case-study for preparing instructions
case and delivering orally to a group

Post CH SS11

Post CH HW11 Prepare a speech to deliver and Sample report to be uploaded


bring out the salient points of your
company’s latest annual report

Post CH LE11

Post CH QZ11

Contact Hour 12 -Technical Proposals and Transaction documents-1

Time Type Sequence Content Reference

Pre CH RL12.1 RL12.1.1 =Introduction- Recorded lecture


objectives, types, characteristics
and importance
RL12.1.2 =General notes on Recorded lecture
structure, style and appearance

During CH12 CH12.1 =Overview


CH CH12.2 =Sample Tender/
RFP/RFQ – to understand the Sample tenders, RFP’s, RFQ’s
content and structure
CH12.3=Writing a sample RFP
Post CH SS12

Post CH HW12 Writing a sample RFP/RFQ Cases list to be prepared and


uploaded by instructor

Post CH LE12

Post CH QZ12 Quiz on different transactional Quiz to be prepared by instructor


documents and processes

Contact Hour 13- Technical Proposals and Transaction documents-2

Time Type Sequence Content Reference

Pre CH RL13.1 RL13.1.1 = Tenders and Recorded lecture


Request of quotations
RL13.1.2= Responding and Recorded lecture
writing Proposals Recorded lecture
RL13.1.2 = Expected evaluation

During CH13 CH12.1 =Overview Sample proposal to be prepared.


CH CH12.2 =Sample Preferably response to the sample
Proposal/Response to RFP in 12.2 above
understand the content and
structure
CH13.4 =Exercise on critically
evaluating the proposal
discussed in 12.2

Post CH SS13 - -

Post CH HW13 Writing a proposal List of RFP’s to be prepared by


instructor

Post CH LE13 - -

Post CH QZ13 - -

Notes:
Contact Hour 14- Business/Technical Reports

Time Type Sequence Content Reference

Pre CH RL14.1 RL10.1.1 =Objectives, Recorded lecture


characteristics and types of
reports Recorded lecture
RL10.1.2 =Principles of
effective Technical and Process
Descriptions

During CH14 CH10.1 =Overview Samples of descriptive writing found


CH CH10.2 =Discussion using a in typical reports- technical and
sample technical description process descriptions
CH10.3=Discussion using a
sample process description

Post CH SS14 - -

Post CH HW14 HW14.1=Find out more about


graphical methods of process
descriptions

Post CH LE14 - -

Post CH QZ14 - -

Contact Hour 15- Preparing to write Reports

Time Type Sequence Content Reference

Pre CH RL15.1 RL15.1.1 =The procedure of Recorded lecture


writing reports- objective,
planning and preparation Recorded lecture
RL15.1.2 = Importance of
structuring and outlining

During CH15 CH15.1 =Overview


CH CH15.2 =Discussion on
specimens of-Analytical,
Laboratory, Inspection,
Progress reports
CH15.4 =Deriving from 15.2-
deriving a procedure for
planning and data collection for
different report types

Post CH SS15 - -

Post CH HW15 HW15=Document a process for


writing reports of different types

Post CH LE15 - -

Post CH QZ15 -- -

Contact Hour 16- Writing Reports

Time Type Sequence Content Reference

Pre CH RL16.1 RL16.1.1 =Writing the report Recorded lecture


RL16.1.2 =Tools and
techniques of collaborative Recorded lecture
writing
RL16.1.3 =Revising, editing,
reviewing Recorded lecture

During CH16 CH16.1 =Overview


CH CH16.2 = Discussion of a
sample project status reports
CH16.3 =Using checklists for
document review
CH16.4= Maintaining document
change history

Post CH SS16

Post CH HW16 HW16=Writing a report; reviewing A list of cases to be uploaded by


a reports instructor, for which different types
of reports can be given as
assignment. Sharing of the submitted
assignments for review by peers.

Post CH LE16

Post CH QZ16

Notes:
Contact Hour 17 – Writing Letters-1

Time Type Sequence Content Reference

Pre CH RL17.1 RL17.1.1 =Principles of letter Recorded lecture


writing
RL17.1.2 = Different types of Recorded Lecture
letters and the importance of
tone
RL17.1.3=Standard formats of Recorded lecture
business letters

During CH17 CH17.1 =Overview Formats and samples to be prepared


CH CH17.2 =Standard formats of and placed on Taxila by Instructor
business letters
CH17.3 =Samples of letters to
distinguish tone, effectiveness
and formatting

Post CH SS17

Post CH HW17 Letter writing assignment Cases to be prepared by Instructor


and assigned in such a way that
different students get different cases

Post CH LE17

Post CH QZ17

Contact Hour 18- Writing Letters-2

Time Type Sequence Content Reference

Pre CH RL18.1 RL18.1.1 =Specific Letters of Recorded lecture


claims, adjustments, credit and
collection Recorded lecture
RL18.1.2 =Responding to
complaints

During CH18 CH18.1 =Overview


CH CH18.2 =Critically examining
sample letters and responses to
bring out the best practices
Post CH SS18 - -

Post CH HW18 HW18.1=Letter writing exercise- Cases to be provided by instructor


choose a specific type and write a
letter
HW18.2=Response to a
resource/product complaint

Post CH LE18 - -

Post CH QZ18 - -

Contact Hour 19 Ethics and Intellectual Property

Time Type Sequence Content Reference

Pre CH RL19.1 RL19.1.1 =Communication Recorded Lecture


ethics
RL19.1.2 =Intellectual Property
Rights Recorded Lecture
RL19.1.3 = Process of Patenting
and documentation required Recorded Lecture

During CH19 CH19.1 =Overview


CH CH19.2 =A sample patent
document to illustrate the
structure and style

Post CH SS19

Post CH HW19

Post CH LE19

Post CH QZ19 QZ1.1 = Quiz questions Quiz sheet (to be provided by


provided by instructor on instructor)
patenting

Notes:
Contact Hour 20 Miscellaneous Topics

Time Type Sequence Content Reference

Pre CH RL20.1 RL20.1.1 =Introduction to an Recorded lecture


Engineer’s Log
RL20.1.2 =Email Etiquette & Recorded lecture
Group Emails Recorded lecture
RL20.1.3 = Writing for
International readers and
response times

During CH20 CH20.1 =Go through sample of Sample of an engineer’s log


CH a log and discuss how this
helps; have student identify the
impact of keeping a log in their
professional situation
CH20.2 =Exercise on writing Case study for email writing exercise
email using a case study
CH20.3 =Case study of a
delayed response
Case study for responding on time

Post CH SS20

Post CH HW20 Writing exercise for a group email Case to be provided by Instructor

Post CH LE20

Post CH QZ20

Evaluation Scheme:
Legend: EC = Evaluation Component; AN = After Noon Session; FN = Fore Noon Session
No Name Type Duration Weight Day, Date, Session, Time
EC-1 Quiz-I/ Assignment-I Online - 5% February 14 to 28, 2019
Quiz-II Online 5% March 14 to 28, 2019
Quiz-III/ Online 5% April 14 to 28, 2019
Assignment-II
EC-2 Mid-Semester Test Closed 2 hours 35% 09/03/2019 (AN)
Book 2 PM – 4 PM
EC-3 Comprehensive Open 3 hours 50% 04/05/2019 (AN)
Exam Book 2 PM – 5 PM

Syllabus for Mid-Semester Test (Closed Book): Topics in Session Nos. 1 to 10


Syllabus for Comprehensive Exam (Open Book): All topics (Session Nos. 1 to 20)
Important links and information:
Elearn portal: https://elearn.bits-pilani.ac.in
Students are expected to visit the Elearn portal on a regular basis and stay up to date with the latest announcements
and deadlines.
Contact sessions: Students should attend the online lectures as per the schedule provided on the Elearn portal.
Evaluation Guidelines:
1. For Closed Book tests: No books or reference material of any kind will be permitted.
2. For Open Book exams: Use of books and any printed / written reference material (filed or bound) is
permitted. However, loose sheets of paper will not be allowed. Use of calculators is permitted in all exams.
Laptops/Mobiles of any kind are not allowed. Exchange of any material is not allowed.
3. If a student is unable to appear for the Regular Test/Exam due to genuine exigencies, the student should
follow the procedure to apply for the Make-Up Test/Exam which will be made available on the Elearn portal.
The Make-Up Test/Exam will be conducted only at selected exam centres on the dates to be announced later.
It shall be the responsibility of the individual student to be regular in maintaining the self study schedule as given in
the course handout, attend the online lectures, and take all the prescribed evaluation components such as
Assignment/Quiz, Mid-Semester Test and Comprehensive Exam according to the evaluation scheme provided in the
handout.

Вам также может понравиться