The presentation slides have been prepared for the webinar session on "Professional Documentation" in the Student Professional Awareness Activities Month (SPAAM)!!!presented on 27th September 2020, organized by the IEEE MACE SB.

1. SPAAM - Students Professional Awareness Activities Month
Organized by
IEEE MACE SB in association with IEEE STUDENTS
27th September 2020.
Webinar Topic: PROFESSIONAL DOCUMENTATION

2. I. What is Documentation?
II. Overview of Professional Documentation
III. Some types of Professional Documentation
IV. Useful references for students
TAKEAWAYS FROM THIS SESSION

3. INTRODUCTION TO DOCUMENTATION
• Documentation is any communicable material that is used to describe, explain or instruct
regarding some attributes of an object, system or procedure.

4. TIPS FOR WRITING PROFESSIONAL DOCUMENTS
1. Practice! Practice! Practice!
2. Make a plan for improvement.
3. Make sure you focus on the purpose for the document
4. Understand your audience.
5. Organize your document for understanding.
6. Ensure a professional appearance.
7. Ensure perfect punctuation, grammar, and spelling.
8. Watch your tone.

5. TO NAME FEW….PROFESSIONAL DOCUMENTS FOR STUDENTS
1. Cover Letter
2. Resume
3. Curriculum Vitae
4. Research Article
5. Project Report
6. Event Report

6. 1. COVER LETTER
• A cover letter is a written document commonly submitted with a job application outlining
the applicant's credentials and interest in the open position.
• A good cover letter complements the resume and explains why the candidate is the ideal
person for the job.

7. SPECIAL CONSIDERATIONS
1. Personalize your letter for each role.
2. Include contact information.
3. Simplify your letter.
4. Be specific when needed.
5. Proofread.

8. SAMPLE COVER LETTER

9. 2. RESUME
• A resume is a document created and used by a person to present their background, skills,
and accomplishments. They can be used for a variety of reasons, but most often they are
used to secure new employment.

11. MY RESUME FOR HIGHER STUDIES

12. TIPS FOR A WINNING RESUME
1. Determine your job search objective prior to writing the resume.
2. Think of your resume as a marketing tool. Use your resume to obtain an interview, not a job.
3. Use bulleted sentences, action words, buzzwords.
4. Accent the positive.
5. Show what you know and who you know.

13. TIPS FOR A WINNING RESUME..cont.
6. Construct your resume to read easily. Have someone else review your resume
7. Lead with your strengths.
8. Submit your resume to potential employers.

14. 3. CURRICULUM VITAE
• A curriculum vitae (CV) provides a summary of your
experience, academic background including teaching
experience, degrees, research, awards, publications,
presentations, and other achievements, skills and credentials.

15. WHAT TO INCLUDE IN CV
• Personal details and contact information.
• Education and qualifications.
• Work experience/employment history.
• Unique Skills.
• Training / Graduate Fieldwork / Study Abroad
• Dissertations / Theses

16. WHAT TO INCLUDE IN CV..cont.
• Research experience
• Teaching experience
• Publications
• Presentations, lectures, and exhibitions
• Grants, scholarships, fellowships, and assistantships
• Awards and honors
• Technical, computer, and language skills
• Professional licenses, certifications, and memberships

17. HOW LONG SHOULD A CV BE?
• A good, entry-level curriculum vitae should ideally cover two to three pages (CVs for mid-level
professionals, especially in academia and medical research roles, may run longer).
• Aim to ensure the content is clear, structured, concise, and relevant. Using bullet points rather
than full sentences can help minimize word usage.

18. SAMPLE CV
Source
SAMPLE CV

21. 4. RESEARCH ARTICLE
• Scientific research articles provide a method for the scientists to communicate with other
community about the results of their research. A standard format is used for these articles,
in which the author presents the research in an orderly, logical manner.

22. • Title--------------------------
• Authors----------------------
• Abstract----------------------
FORMAT FOR THE PAPER
WHAT IS TITLE
WHO IS AN AUTHOR
WHAT IS ABSTRACT

23. • Introduction--------------------------------------------
• Materials and Methods-------------------------------
• Results--------------------------------------------------
• Discussion----------------------------------------------
• Conclusion---------------------------------------------
• References (Literature Cited)------------------------
FORMAT FOR THE PAPER cont..
Edit Your Paper!!!
"In my writing, I average about ten pages a day. Unfortunately, they're all the same page.“-
Michael Alley, The Craft of Scientific Writing
WHAT IS INTRODUCTION
WHAT ARE MATERIALS & METHODS
WHAT ARE RESULTS
WHAT IS DISCUSSION
WHAT IS CONCLUSION
WHAT ARE REFERENCES

24. 5. PROJECT REPORT
Why a report?
• The production of a good piece of technical writing for a project report is as much a part
of the project as doing the experimental work. However excellent and original a piece of
work the project may be, unless the results can be communicated to other people it may as
well not have been done!

25. How much detail to include in a Project Report?
One of the most important aspects of good technical writing is to be concise, yet remain
informative. The ability to select what is essential, and to omit what is merely incidental detail,
is a skill every scientist needs to develop.
In view of this, the main part of your report must be within the word limit(s) specified in the
applicable module description. An overlong report will be penalized and receive a lower mark
than it otherwise deserves.

26. The Structure of Page Arrangements for the Project Report
1.Title & Cover Page
2.Declaration
3.Approval or Certification
4.Acknowledgments
5.Abstract
6.Table of Contents
7.List of Figures
8.List of Tables

27. The Structure of Page Arrangements for the Project Report
9. List of Symbols and Abbreviations
10. Body of the Project & the Chapters
11.Introduction
12.Experiments and Results
13. Conclusion and Recommendations
14. Future Scope
15.References
16.Appendices

28. 6. EVENT REPORT
• Creating a post-event report template is an essential part of any event you organize. This is
because reporting on an event gives you and your client valuable insight as to how effective
the event actually was.

29. Preparing to write a post event report
• Schedule time to write and publish the report within 48 hours of the event.
• Take good notes.
• Include photos and video or audio recordings; make sure to embed them in the post.
Linking to these resources is recommended.
• Provide important stats in your post that are relevant to the event.
• Make sure to genuinely thank your event vendors, volunteers, and sponsors.

30. Source:
Write-an-Event-Report

31. BIBLIOGRAPHY
• Documentation
• cover-letter
• Resume
• how-long-should-a-resume-be
• research/paper
• twenty-steps-writing-research-article
• handbook for project report.pdf
• final-project-report-format-for-engineering-students/
• how-to-write-a-post-event-report-to-get-actionable-insights/

32. Acknowledgement
My heartfelt thanks to the IEEE MACE SB for a warm invitation as a guest speaker in
today’s webinar session on "Professional Documentation" in the Student Professional
Awareness Activities Month (SPAAM)!!!
Thank you for the wonderful welcome from the committee!!
Kudos to everyone who have done tremendous work in carrying out this unique SPAAM
program to a next level!!

33. Thank you all for your kind attention!
Aditya Allamraju
https://www.linkedin.com/in/aditya-allamraju/
https://www.researchgate.net/profile/Aditya_Allamraju