Technical paper writing

21
1 Technical Writing Lt Col L Shri Harsha, Retd, PgMP, PMP VP – Academic Relations

Transcript of Technical paper writing

Page 1: Technical paper writing

1

Technical Writing     

Lt Col L Shri Harsha, Retd, PgMP, PMP VP – Academic Relations

Page 2: Technical paper writing

2

• Writing a technical paper/case study• Bio break• Making effective presentations

Agenda

Page 3: Technical paper writing

3

Objective

Understand the nuances of writing a

quality technical paper/case study and

making effective presentations.

Page 4: Technical paper writing

4

• Abstract• Introduction• Main body• Takeaways• Conclusion• References• Acknowledgements• Annexures and Appendices• Authors profile• General tips

Organizing a Technical Paper

Page 5: Technical paper writing

5

• Selling point• Not a brief introduction of the paper• Standalone mini summary of the paper• Problem, approach and solution• Factual and comprehensive• Do not repeat word to word in main paper• No references to the footnote

Abstract

Page 6: Technical paper writing

6

• Target audience are not lay persons• Define the problem, its importance and

the challenges• If solved earlier, why isn't it right• The current approach to the problem• Clear statement of the work, expansion

of the abstract

Introduction

Page 7: Technical paper writing

7

• Meat of the paper, include work done, results, analysis, and discussions

• Pick up from the introduction• Discuss the methodology/approach of the

solution• Delineate material that is not original but

needed for the paper• Provide interpretation for your results and

describe significant findings

Main Body

Page 8: Technical paper writing

8

• Lessons learnt – positive and negative• Industry application options• Define scope for future studies if any

Takeaways

Page 9: Technical paper writing

9

• Do not repeat abstract or introduction or summarize the paper

• Present the conclusion from the main content

• Thoughts that the readers can extend or take to next level

Conclusion

Page 10: Technical paper writing

10

• Can be either at end of each page or end of paper

• Different styles of referencing• Must contain author name, title of

publication, year of publication, name of publisher and page number

• Web addresses

References

Page 11: Technical paper writing

11

• Avoid, unless very essential• Appendix – supplementary document,

additional information• Not contain any material essential to

understand the paper

Acknowledgements, Appendices and Annexures

Page 12: Technical paper writing

12

• Name and highest qualification with certifications

• Present company, designation and role• Major achievements• Contact details, if willing• No personal details, hobbies, family

details etc.

Author’s profile

Page 13: Technical paper writing

13

• Vocabulary• Proof check• Careful with ‘etc’, that, this and for

various reasons• Follow format provided• Italics are for definitions or quotes, not

emphasis

• Tables, charts and figures

Guidelines

Page 14: Technical paper writing

14

• Abstract - 3% to 5%• Introduction - 5% to 10%• Main body - Max of 70%• Takeaways - 8% to 10%• Conclusion - 5% to 8%• References -• Acknowledgements

Guidelines

Page 15: Technical paper writing

15

Q & A

Page 16: Technical paper writing

16

10 mins break

Page 17: Technical paper writing

17

• Determine the purpose - Inform, persuade and educate

• Know your audience• Prepare a script• Practice and fine tune• Body language • Plan for Q & A• Stick to time allotted

Effective Presentations

Page 18: Technical paper writing

18

• Keep background simple• Avoid information in the paper• No paragraphs• Preferably, bullet points• Prepare a story board• Don’t read off from the slide• Take care of the tables and charts• Careful with animations and transitions

Effective Presentations

Page 19: Technical paper writing

19

• Enable conversational flow• Flexible• Audience responsive• Avoid debates and arguments• Use images to make an abstract more

concrete• One thing at a time on the screen • Avoid thanks giving lines

Effective Presentations

Page 20: Technical paper writing

20

Q & A